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

final class RawEntry extends DbpfEntry

A buffered entry whose raw byte data is held in an array, that is, the exact data that would be written to a file (compressed or uncompressed).

This differs from a BufferedEntry in that the latter always holds the uncompressed data. Thus, a BufferedEntry is suited for access and modification of the content, but a RawEntry is usually suitable for just holding the data in memory, as creating the input does not require an intermediate compression. If the data is not compressed, this distinction is not as important.

Instances of this class are immutable, if the data it was created from was. Note that conversion between RawEntries and BufferedEntries references the same backing array if possible. If created from a StreamedEntry, a new data array will be created, hence, the entry will be immutable.

Source
entries.scala
See also

BufferedEntry

StreamedEntry

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

Instance Constructors

  1. new RawEntry(tgi: Tgi, data: Array[Byte])

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( ... ) @native()
  6. def compressed: Boolean
  7. def copy(tgi: Tgi): RawEntry

    Creates a new entry with a different tgi.

  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  10. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. def input(): Input[Byte]

    the byte input that provides the raw byte data that gets written to DBPF files

    the byte input that provides the raw byte data that gets written to DBPF files

    Definition Classes
    RawEntry → DbpfEntry
  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. val tgi: Tgi

    the TGI of this entry

    the TGI of this entry

    Definition Classes
    RawEntry → DbpfEntry
  20. def toBufferedEntry(implicit eh: ExceptionHandler): ![BufferedEntry[DbpfType], DbpfIoException]

    Converts this entry to a BufferedEntry.

    Converts this entry to a BufferedEntry.

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

    Definition Classes
    RawEntry → DbpfEntry
  21. def toRawEntry(implicit eh: ExceptionHandler): ![RawEntry, DbpfIoException]

    Converts this entry to a RawEntry.

    Converts this entry to a RawEntry.

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

    Definition Classes
    RawEntry → DbpfEntry
  22. def toString(): String
    Definition Classes
    AnyRef → Any
  23. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from DbpfEntry

Inherited from AnyRef

Inherited from Any

Ungrouped