Quaternion
Description​
This component controls how the entity is rotated.
Properties​
| Property | Type | Default | Description |
|---|---|---|---|
| x | number | 0 | x coordinate |
| y | number | 0 | y coordinate |
| z | number | 0 | z coordinate |
| w | number | 0 | w coordinate |
Functions​
Get​
Returns a read-only reference.
Example
ecs.Quaternion.get(world, component.eid)
Set​
Ensures the component exists on the entity, then assigns the (optional) data to the component.
Example
ecs.Quaternion.set(world, component.eid, {
x: 0,
y: 0,
z: 0,
w: 0
})
Mutate​
Perform an update to the component within a callback function. Return true to indicate no changes made.
Example
ecs.Quaternion.mutate(world, component.eid, (cursor) => {
cursor.x = 1;
cursor.y = 1;
cursor.z = 1;
cursor.w = 1;
return false;
})
Remove​
Removes the component from the entity.
Example
ecs.Quaternion.remove(world, component.eid)
Has​
Returns true if the component is present on the entity.
Example
ecs.Quaternion.has(world, component.eid)
Reset​
Adds, or resets the component to its default state.
Example
ecs.Quaternion.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.Quaternion.cursor(world, component.eid)
Acquire​
Same behavior as cursor, but commit must be called after the cursor is done being used.
Example
ecs.Quaternion.acquire(world, component.eid)
Commit​
Called after acquire. An optional third argument determines whether the cursor was mutated or not.
Example
ecs.Quaternion.commit(world, component.eid)
ecs.Quaternion.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.Quaternion.dirty(world, component.eid)