BaseObject

Hierarchy

• BaseObject
  • BaseObject

Index

Properties

• id
• refCount
• type
• valid

Methods

• deleteMeta
• deleteSyncedMeta
• destroy
• getMeta
• getMetaDataKeys
• getSyncedMeta
• getSyncedMetaKeys
• hasMeta
• hasSyncedMeta
• setMeta
• setSyncedMeta
• getByID

Properties

publicreadonlyid

id: number

Inherited from shared.BaseObject.id

publicreadonlyrefCount

refCount: number

Returns the ref count of the entity.

Remarks

It’s only available in debug-mode.

Inherited from shared.BaseObject.refCount

publicreadonlytype

type: BaseObjectType

Type of the object.

Inherited from shared.BaseObject.type

publicreadonlyvalid

valid: boolean

Object usability.

Returns

False if object is no longer usable.

Inherited from shared.BaseObject.valid

Methods

publicdeleteMeta

• deleteMeta(key: string): void
• deleteMeta<K>(key: K): void

• Overrides shared.BaseObject.deleteMeta

publicdeleteSyncedMeta

• deleteSyncedMeta(key: string): void
• deleteSyncedMeta<K>(key: K): void

• Removes the specified key and the data connected to that specific key.

publicdestroy

• destroy(): void

• Inherited from shared.BaseObject.destroy

  Removes the object from the world.

publicgetMeta

• getMeta<K>(key: Exclude<K, never>): unknown
• getMeta<K>(key: K): undefined | ICustomBaseObjectMeta[K]
• getMeta<V>(key: string): undefined | V

• Overrides shared.BaseObject.getMeta

  Type parameters

  • K: string

publicgetMetaDataKeys

• getMetaDataKeys(): readonly string[]

• Inherited from shared.BaseObject.getMetaDataKeys

publicgetSyncedMeta

• getSyncedMeta<K>(key: Exclude<K, never>): unknown
• getSyncedMeta<K>(key: K): undefined | ICustomBaseObjectSyncedMeta[K]
• getSyncedMeta<V>(key: string): undefined | V

• Inherited from shared.BaseObject.getSyncedMeta

  Gets a value using the specified key.

  ---

  Type parameters

  • K: string

publicgetSyncedMetaKeys

• getSyncedMetaKeys(): readonly string[]

• Inherited from shared.BaseObject.getSyncedMetaKeys

publichasMeta

• hasMeta(key: string): boolean
• hasMeta<K>(key: K): boolean

• Overrides shared.BaseObject.hasMeta

publichasSyncedMeta

• hasSyncedMeta(key: string): boolean
• hasSyncedMeta<K>(key: K): boolean

• Inherited from shared.BaseObject.hasSyncedMeta

  Determines whether contains the specified key.

publicsetMeta

• setMeta<K>(key: K, value: InterfaceValueByKey<ICustomBaseObjectMeta, K, unknown, void>): void
• setMeta<K>(key: K, value: ICustomBaseObjectMeta[K]): void
• setMeta<V, K>(key: K, value: InterfaceValueByKey<ICustomBaseObjectMeta, K, V, void>): void

• Overrides shared.BaseObject.setMeta

  Type parameters

  • K: string

publicsetSyncedMeta

• setSyncedMeta<K>(key: K, value: InterfaceValueByKey<ICustomBaseObjectSyncedMeta, K, unknown, void>): void
• setSyncedMeta<K>(key: K, value: ICustomBaseObjectSyncedMeta[K]): void
• setSyncedMeta<V, K>(key: K, value: InterfaceValueByKey<ICustomBaseObjectSyncedMeta, K, V, void>): void

• Stores the given value with the specified key.

  Remarks

  The given value will be shared with all clients.

  ---

  Type parameters

  • K: string

publicstaticgetByID

• getByID(type: BaseObjectType, id: number): null | BaseObject

• Gets the base object with the given type and id