Class Resource`Abstract`

Base class for all user-defined TypeScript resources. TypeScript resources are automatically serialized, can be saved and persistently referenced by other objects.

Hierarchy (View Summary)

Resource

Index

Constructors

Accessors

handle isDestroyed metaData name uuid

Methods

duplicate onCreate onDeserializationEnded onDisable onEnable onInitialize onSerializationStart revert unload

Constructors

constructor

new Resource(uuid?: UUID, isInternalConstructor?: boolean): Resource
Internal function for construction.
Parameters
- Optionaluuid: UUID
- OptionalisInternalConstructor: boolean
Returns Resource

Note
You should never override the constructor for resources. Always rely on onCreate or onInitialize to initialize your resource.

Overrides FrameworkObject.constructor

Accessors

handle

get handle(): ResourceHandle

Returns a resource handle.

Returns ResourceHandle

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

get metaData(): ResourceMetaData

Returns the meta data of this resource.

Returns ResourceMetaData

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.

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

unload(): void

Forcefully unloads the resource.

Returns void