Class EntitySharedProperties

Index

Constructors

Methods

getAllSharedProperties getSharedPropertiesAsSyncData getSharedProperty hasSharedProperty resetSharedProperty setSharedProperty

Constructors

constructor

new EntitySharedProperties(entity: Entity): EntitySharedProperties
Create a new entity property map
Parameters
- entity: Entity
  The entity that this property map is attached to
Returns EntitySharedProperties
- Defined in packages/core/src/entity/shared-properties.ts:45

Methods

getAllSharedProperties

getAllSharedProperties(): [string, SharedPropertyValue][]
Get all the shared properties of the entity that are shared with the client.

Returns [string, SharedPropertyValue][]
An array of tuples containing the identifier and value of each property.
- Defined in packages/core/src/entity/shared-properties.ts:91

getSharedPropertiesAsSyncData

getSharedPropertiesAsSyncData(): PropertySyncData
Get the shared properties of the entity as a PropertySyncData object. This is used to sync the properties with the client.

Returns PropertySyncData
The PropertySyncData object.
- Defined in packages/core/src/entity/shared-properties.ts:361

getSharedProperty

getSharedProperty<T extends SharedPropertyValue>(identifier: string): T
Get the shared property of the entity that is shared with the client.
Type Parameters
- T extends SharedPropertyValue
Parameters
- identifier: string
  The identifier of the property.
Returns T
The value of the property.

Throws
Error if the property does not exist on the entity type.
- Defined in packages/core/src/entity/shared-properties.ts:136

hasSharedProperty

hasSharedProperty(identifier: string): boolean
Check if the entity has a shared property with the given identifier.
Parameters
- identifier: string
  The identifier of the property.
Returns boolean
True if the property exists, false otherwise.
- Defined in packages/core/src/entity/shared-properties.ts:126

resetSharedProperty

resetSharedProperty(identifier: string): void
Reset the shared property of the entity to its default value.
Parameters
- identifier: string
  The identifier of the property.
Returns void
- Defined in packages/core/src/entity/shared-properties.ts:311

setSharedProperty

setSharedProperty<T extends SharedPropertyValue>(
identifier: string,
value: T,
): void
Sets the shared property of the entity that is shared with the client.
Type Parameters
- T extends SharedPropertyValue
Parameters
- identifier: string
  The identifier of the property.
- value: T
  The value of the property.
Returns void
- Defined in packages/core/src/entity/shared-properties.ts:182