Skip to main content

FlyController

Description​

This component lets you control the object and move freely around the space

Properties​

PropertyTypeDefaultDescription
verticalSensitivitynumber1Input sensitivity vertically
horizontalSensitivitynumber1Input sensitivity horizontally
moveSpeedXnumber10Movement speed of the x axis
moveSpeedYnumber10Movement speed of the y axis
moveSpeedZnumber10Movement speed of the z axis
invertedXbooleanfalseWhether X input is inverted
invertedYbooleanfalseWhether Y input is inverted

Functions​

Get​

Returns a read-only reference.

Example

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

Set​

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

Example

ecs.FlyController.set(world, component.eid, {
  verticalSensitivity: 1,
  horizontalSensitivity: 1,
  moveSpeedX: 10,
  moveSpeedY: 10,
  moveSpeedZ: 10,
  invertedX: false,
  invertedY: false
})

Mutate​

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

Example

ecs.FlyController.mutate(world, component.eid, (cursor) => {
  cursor.verticalSensitivity = 2;
  cursor.horizontalSensitivity = 2;
  return false;
})

Remove​

Removes the component from the entity.

Example

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

Has​

Returns true if the component is present on the entity.

Example

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

Reset​

Adds, or resets the component to its default state.

Example

ecs.FlyController.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.FlyController.cursor(world, component.eid)

Acquire​

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

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

Commit​

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

Example
ecs.FlyController.commit(world, component.eid)
ecs.FlyController.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.FlyController.dirty(world, component.eid)