Class JavaScriptCode

The JavaScriptCode class implements a Resource that contains cooked JavaScript game or editor code.

Hierarchy (view full)

Constructors

constructor

Accessors

code declaration flags handle isCompatibleWithCurrentEngineVersion isDestroyed metaData minimumMajorEngineVersion minimumMinorEngineVersion name uuid

Methods

duplicate isCompatibleWithEngineVersion onCreate onDeserializationEnded onDisable onEnable onInitialize onSerializationStart revert unload

Constructors

constructor

Accessors

code

  • get code(): string

  • Sets the source code contained in the resource.

    Returns string

  • set code(value): void

  • Parameters

    • value: string

    Returns void

declaration

  • get declaration(): string

  • Sets the declaration contained in the resource.

    Returns string

  • set declaration(value): void

  • Parameters

    • value: string

    Returns void

flags

handle

isCompatibleWithCurrentEngineVersion

  • get isCompatibleWithCurrentEngineVersion(): boolean

  • Determines whether the JavaScriptCode is compatible with the current engine version.

    Returns boolean

isDestroyed

  • get isDestroyed(): boolean

  • Determines if the resource is destroyed.

    Returns boolean

    Note

    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.

metaData

minimumMajorEngineVersion

  • get minimumMajorEngineVersion(): number

  • Indicates the minimum major version of the engine required to load this JavaScript code.

    Returns number

  • set minimumMajorEngineVersion(value): void

  • Parameters

    • value: number

    Returns void

minimumMinorEngineVersion

  • get minimumMinorEngineVersion(): number

  • Indicates the minimum minor version of the engine required to load this JavaScript code.

    Returns number

  • set minimumMinorEngineVersion(value): void

  • Parameters

    • value: number

    Returns void

name

  • get name(): string

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

    Returns string

uuid

  • get uuid(): UUID

  • Returns a universally unique identifier of this resource.

    Returns UUID

Methods

duplicate

  • duplicate(): Resource

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

    Returns Resource

    The duplicated resource or null, if the duplication failed.

isCompatibleWithEngineVersion

  • isCompatibleWithEngineVersion(major, minor): boolean

  • Determines whether the JavaScriptCode is compatible with the specified major and minor engine version.

    Parameters

    • major: number
    • minor: number

    Returns boolean

onCreate

  • onCreate(): void
  • Virtual

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

    Returns void

onDeserializationEnded

  • onDeserializationEnded(): void
  • Virtual

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

    Returns void

    Note

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

onDisable

  • onDisable(): void
  • Virtual

    Method called by RSX to disable the resource.

    Returns void

    Note

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

onEnable

  • onEnable(): void
  • Virtual

    Method called by RSX to enable the resource.

    Returns void

    Note

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

onInitialize

  • onInitialize(): void
  • Virtual

    Method called by RSX to perform initialization of the resource.

    Returns void

    Note

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

onSerializationStart

  • onSerializationStart(): void
  • Virtual

    Method called by RSX to perform any operations before serialization.

    Returns void

    Note

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

revert

  • revert(): boolean

  • Reverts the resource to the on-disk representation.

    Returns boolean

    Note

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

unload

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods