Fixed links. |
add fields |
||
(4 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
The '''IWorldElement''' type is an [[interface type]] that represents any object of a [[reference type]] that may exist in a world. It is the foundation of the [[data model]]. | |||
IWorldElement | Every object that can be referenced can be cast to and from IWorldElement, making the type a universal interface to everything in a world. | ||
Objects that are IWorldElements include, but are not limited to: | |||
* [[ | * [[Slots]] | ||
* [[ | * [[Components]] | ||
* [[ | * [[Users]] | ||
* [[Type: | * [[Type:SyncElement|Sync Elements]], such as [[Type:IField|fields]] on an object | ||
* [[Type:SyncObject|Sync Objects]] | * [[Type:SyncObject|Sync Objects]], such as <code>Point</code>s on a [[Component:ValueGradientDriver|ValueGradientDriver]] | ||
Every IWorldElement has a unique [[Type:RefID|reference ID]] associated with it. Only one IWorldElement in a world may have any given reference ID, including elements that exist outside of the [[Root]] hierarchy. | |||
== Fields == | |||
{{Table TypeFields | |||
|ReferenceID|RefID|Reference ID of the element. | |||
|Name|string|Name of the element. | |||
|World|World|World that the element exists in. | |||
|Parent|IWorldElement|Potential parent element. Can be null. | |||
|IsLocalElement|bool|Whether the element exists only for the local user and nobody else. | |||
|IsPersistent|bool|Whether the element is marked as persistent, meaning it will get saved when a save event occurs on it or its parents. | |||
|IsRemoved|bool|Whether the element is removed from the world. | |||
}} | |||
[[Category:Type]] | [[Category:Type]] | ||
[[Category:Reference types]] |
Latest revision as of 18:14, 30 June 2025
The IWorldElement type is an interface type that represents any object of a reference type that may exist in a world. It is the foundation of the data model.
Every object that can be referenced can be cast to and from IWorldElement, making the type a universal interface to everything in a world.
Objects that are IWorldElements include, but are not limited to:
- Slots
- Components
- Users
- Sync Elements, such as fields on an object
- Sync Objects, such as
Point
s on a ValueGradientDriver
Every IWorldElement has a unique reference ID associated with it. Only one IWorldElement in a world may have any given reference ID, including elements that exist outside of the Root hierarchy.
Fields
Name | Type | Description |
---|---|---|
ReferenceID
|
RefID | Reference ID of the element. |
Name
|
string | Name of the element. |
World
|
World | World that the element exists in. |
Parent
|
IWorldElement | Potential parent element. Can be null. |
IsLocalElement
|
bool | Whether the element exists only for the local user and nobody else. |
IsPersistent
|
bool | Whether the element is marked as persistent, meaning it will get saved when a save event occurs on it or its parents. |
IsRemoved
|
bool | Whether the element is removed from the world. |