Packages

  • package root
    Definition Classes
    root
  • package io
    Definition Classes
    root
  • package github
    Definition Classes
    io
  • package memo33
    Definition Classes
    github
  • package scdbpf

    Provides methods for accessing and modifying the contents of DBPF formatted files.

    Provides methods for accessing and modifying the contents of DBPF formatted files. Currently, only DBPF version 1.0 is supported (used by SimCity 4).

    DBPF files are accessed via DbpfFiles, a container of DbpfEntries. The content of a DbpfEntry can be accessed from BufferedEntries in decoded form as DbpfType, such as Exemplar, Fsh or Sc4Path.

    This package object provides additional type aliases for DbpfExceptions.

    Examples

    To get started, it is easiest to start the REPL via sbt console, which loads all the dependencies and useful initial import statements. Reading a DBPF file, sorting its entries by TGI and writing back to the same file could be achieved like this:

    val dbpf = DbpfFile.read(new File("foobar.dat"))
dbpf.write(dbpf.entries.sortBy(_.tgi))

    This example shifts the GIDs of all LTexts by +3:

    dbpf.write(dbpf.entries.map { e =>
  if (e.tgi matches Tgi.LText)
    e.copy(e.tgi.copy(gid = e.tgi.gid + 3))
  else
    e
})

    Another example: This decodes all the Sc4Path entries and rotates them by 90 degree.

    val writeList = for (e <- dbpf.entries) yield {
  if (e.tgi matches Tgi.Sc4Path) {
    val be = e.toBufferedEntry.convertContentTo(Sc4Path)
    be.copy(content = be.content * RotFlip.R1F0)
  } else {
    e
  }
}
dbpf.write(writeList)

    The following example finds the first entry that is an exemplar and contains a property with a specific ID. (Note the view to avoid unnecessary decoding if the exemplar is already among the first entries.)

    val id = UInt(0x12345678)
dbpf.entries.view.
  filter(_.tgi matches Tgi.Exemplar).
  map(_.toBufferedEntry.convertContentTo(Exemplar)).
  find(_.content.properties.contains(id))
    Definition Classes
    memo33
  • package compat
    Definition Classes
    scdbpf
  • BufferedEntry
  • DbpfEntry
  • DbpfExceptions
  • DbpfFile
  • DbpfPackager
  • DbpfProperty
  • DbpfType
  • DbpfTypeCompanion
  • DbpfUtil
  • Exemplar
  • Experimental
  • Fsh
  • LText
  • RawEntry
  • RawType
  • S3d
  • Sc4Path
  • StreamedEntry
  • Tgi
  • TgiMask
  • WithContentConverter

class RawType extends DbpfType

A raw type that does not represent any specific format. Its data is backed by an array. As such, it is also suited as a super class of specialized types which are backed by an array.

Instances of this class my be obtained via the companion object.

Source
types.scala
Note

This is one of the few spots where the raw backing array gets exposed. If instances of this class or created from instances of this class are meant to be immutable, it is required to ensure that this array does not get modified.

Linear Supertypes
DbpfType, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RawType
  2. DbpfType
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new RawType(data: Array[Byte])
    Attributes
    protected

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  6. def convert[B <: DbpfType](implicit eh: ExceptionHandler, conv: Converter[DbpfType, B]): ![B, DbpfDecodeFailedException]

    Deprecated: Prefer convertTo instead.

    Deprecated: Prefer convertTo instead.

    Converts this type to B. The implicit converter is usually provided by the companion object of B.

    An ExceptionHandler needs to be brought into scope via imports (either strategy.throwExceptions or strategy.captureExceptions from the scdbpf package).

    B

    the type which this type gets converted to

    Definition Classes
    DbpfType
    Exceptions thrown

    DbpfDecodeFailedException if this type cannot be converted to type B structurally

  7. def convertTo[B <: DbpfType](dbpfType: DbpfTypeCompanion[B])(implicit eh: ExceptionHandler): ![B, DbpfDecodeFailedException]

    Convert this type to B.

    Convert this type to B.

    An ExceptionHandler needs to be brought into scope via imports (either strategy.throwExceptions or strategy.captureExceptions from the scdbpf package).

    B

    the type which this type gets converted to

    dbpfType

    (the companion object of) the type which this type gets converted to

    Definition Classes
    DbpfType
    Exceptions thrown

    DbpfDecodeFailedException if this type cannot be converted to type B structurally

  8. val data: Array[Byte]

    the uncompressed raw byte data of the entry

    the uncompressed raw byte data of the entry

    Attributes
    protected
    Definition Classes
    RawType → DbpfType
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  11. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  12. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  19. def toString(): String
    Definition Classes
    AnyRef → Any
  20. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  21. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  22. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from DbpfType

Inherited from AnyRef

Inherited from Any

Ungrouped