RSX Code Reference
    Preparing search index...

    Class Scene

    Saved hierarchy of scene objects that can be instantiated on demand.

    Hierarchy (View Summary)

    Index
    constructor
    handle hash isDestroyed localSequential metaData name root uuid
    duplicate instantiate onCreate onDeserializationEnded onDisable onEnable onInitialize onSerializationStart revert unload update

    • Creates a new scene from the provided scene object.

      Parameters

      • uuid: UUID
      • sceneObject: SceneObject

        Root scene object to create the scene from.

      • OptionalisInternalConstructor: boolean

      Returns Scene

    • get hash(): UUID

      Returns a hash value that can be used for determining if a template changed by comparing it to a previously saved hash.

      Returns UUID

    • get isDestroyed(): boolean

      Determines if the resource is destroyed.

      Returns boolean

      This can happen when the Resource was forcefully unloaded or reverted. For this reason, it is safer to hold on to a instead of directly referencing a resource pointer, as the current Resource can always be retrieved via .value.

    • get localSequential(): number

      Returns the sequential version of the template content.

      Returns number

    • get name(): string

      Name of the resource. Use primarily for easier identification and not important to the engine itself.

      Returns string

    • get root(): SceneObject

      Returns a reference to the internal template hierarchy. Returned hierarchy is not instantiated and cannot be interacted with in a manner you would with normal scene objects.

      Returns SceneObject

    • get uuid(): UUID

      Returns a universally unique identifier of this resource.

      Returns UUID

    • Duplicates the resource and creates a unique UUID for the duplicated resource.

      Returns Resource

      The duplicated resource or null, if the duplication failed.

    • Instantiates a scene by creating an instance of the stored scene object hierarchy.

      Returns SceneInstance

    • Virtual

      Method called by RSX to perform actions required after the creation of the resource.

      Returns void

    • Virtual

      Method called by RSX to perform any operations needed after deserialization.

      Returns void

      Use this API to restore your serializable data into live objects.

    • Virtual

      Method called by RSX to disable the resource.

      Returns void

      Use this API to deactivate the resource before it is serialized.

    • Virtual

      Method called by RSX to enable the resource.

      Returns void

      Use this API to activate the resource after it has been disabled by serialization.

    • Virtual

      Method called by RSX to perform initialization of the resource.

      Returns void

      Use this API to initialize data and default construct all fields.

    • Virtual

      Method called by RSX to perform any operations before serialization.

      Returns void

      Use this API to bake your live data into serializable data.

    • Reverts the resource to the on-disk representation.

      Returns boolean

      This is a potentially expensive call, as it needs to deserialize and replace all existing in-memory resource handles.

    • Replaces the contents of this template with new contents from the provided object. Object will be automatically linked to this template, and its previous template link (if any) will be broken.

      Parameters

      Returns void

    Settings
    Member Visibility

    On This Page
    Constructors
    Accessors
    Methods