Saltar al contenido principal

Persistent

Description​

This component marks the entity it is attached to as Persistent, which means it will not be despawned when unmounting the Space (switching Spaces). Can only be set on root objects.

Properties​

None

Functions​

Get​

Returns a read-only reference.

Example

ecs.Persistent.get(world, component.eid)

Set​

Ensures the component exists on the entity, then assigns the (optional) data to the component.

Example

ecs.Persistent.set(world, component.eid, {})

Mutate​

Perform an update to the component within a callback function. Return true to indicate no changes made.

Example

ecs.Persistent.mutate(world, component.eid, (cursor) => {
  return false
})

Remove​

Removes the component from the entity.

Example

ecs.Persistent.remove(world, component.eid)

Has​

Returns true if the component is present on the entity.

Example

ecs.Persistent.has(world, component.eid)

Reset​

Adds, or resets the component to its default state.

Example

ecs.Persistent.reset(world, component.eid)

Advanced Functions​

Cursor​

Returns a mutable reference. Cursors are reused so only one cursor for each component can exist at a time.

Example
ecs.Persistent.cursor(world, component.eid)

Acquire​

Same behavior as cursor, but commit must be called after the cursor is done being used.

Example
ecs.Persistent.acquire(world, component.eid)

Commit​

Called after acquire. An optional third argument determines whether the cursor was mutated or not.

Example
ecs.Persistent.commit(world, component.eid)
ecs.Persistent.commit(world, component.eid, false)

Dirty​

Mark the entity as having been mutated. Only needed in a specific case where systems are mutating data.

Example
ecs.Persistent.dirty(world, component.eid)