Skip to content

Class: SectorScene

Methods

NameDescription
:addComponentBounds(entityId,data)
:addComponentCollisionShape(entityId,data)
:addComponentGrid(entityId,data)
:addComponentIcon(entityId,data)
:addComponentLabel(entityId,data)
:addComponentModel(entityId,data)
:addComponentNetwork(entityId,data)
:addComponentPathfinding(entityId,data)
:addComponentPlayerControl(entityId,data)
:addComponentRigidBody(entityId,data)
:addComponentRigidBody(entityId,data)
:addComponentShip(entityId,data)
:addComponentTransform(entityId)
:addEntityType(name,type)
:createEntity()
:createEntityType(name,props)
:getComponentBounds(entityId)
:getComponentCollisionShape(entityId)
:getComponentGrid(entityId)
:getComponentIcon(entityId)
:getComponentLabel(entityId)
:getComponentModel(entityId)
:getComponentNetwork(entityId)
:getComponentPathfinding(entityId)
:getComponentPlayerControl(entityId)
:getComponentRigidBody(entityId)
:getComponentRigidBody(entityId)
:getComponentShip(entityId)
:getComponentTransform(entityId)
:patchComponentBounds(entityId)
:patchComponentCollisionShape(entityId)
:patchComponentGrid(entityId)
:patchComponentIcon(entityId)
:patchComponentLabel(entityId)
:patchComponentModel(entityId)
:patchComponentNetwork(entityId)
:patchComponentPathfinding(entityId)
:patchComponentPlayerControl(entityId)
:patchComponentRigidBody(entityId)
:patchComponentRigidBody(entityId)
:patchComponentShip(entityId)
:patchComponentTransform(entityId)
:removeEntity(entityId)

Fields

NameTypeDescription
physicsPhysicsDynamicsWorld

Method declarations

Method: addComponentBounds

lua
function SectorScene:addComponentBounds(
    entityId,
    data
) end

Parameters:

  • entityId (integer)
  • data (table)

Returns:

Method: addComponentCollisionShape

lua
function SectorScene:addComponentCollisionShape(
    entityId,
    data
) end

Parameters:

  • entityId (integer)
  • data (table)

Returns:

Method: addComponentGrid

lua
function SectorScene:addComponentGrid(
    entityId,
    data
) end

Parameters:

  • entityId (integer)
  • data (table)

Returns:

Method: addComponentIcon

lua
function SectorScene:addComponentIcon(
    entityId,
    data
) end

Parameters:

  • entityId (integer)
  • data (table)

Returns:

Method: addComponentLabel

lua
function SectorScene:addComponentLabel(
    entityId,
    data
) end

Parameters:

  • entityId (integer)
  • data (table)

Returns:

Method: addComponentModel

lua
function SectorScene:addComponentModel(
    entityId,
    data
) end

Parameters:

  • entityId (integer)
  • data (table)

Returns:

Method: addComponentNetwork

lua
function SectorScene:addComponentNetwork(
    entityId,
    data
) end

Parameters:

  • entityId (integer)
  • data (table)

Returns:

Method: addComponentPathfinding

lua
function SectorScene:addComponentPathfinding(
    entityId,
    data
) end

Parameters:

  • entityId (integer)
  • data (table)

Returns:

Method: addComponentPlayerControl

lua
function SectorScene:addComponentPlayerControl(
    entityId,
    data
) end

Parameters:

  • entityId (integer)
  • data (table)

Returns:

Method: addComponentRigidBody

lua
function SectorScene:addComponentRigidBody(
    entityId,
    data
) end

Parameters:

  • entityId (integer)
  • data (table)

Returns:

Method: addComponentRigidBody

lua
function SectorScene:addComponentRigidBody(
    entityId,
    data
) end

Parameters:

  • entityId (integer)
  • data (table)

Returns:

Method: addComponentShip

lua
function SectorScene:addComponentShip(
    entityId,
    data
) end

Parameters:

  • entityId (integer)
  • data (table)

Returns:

Method: addComponentTransform

lua
function SectorScene:addComponentTransform(
    entityId
) end

Parameters:

  • entityId (integer)

Returns:

Method: addEntityType

lua
function SectorScene:addEntityType(
    name,
    type
) end

Parameters:

  • name (string) - Name of the entity to define
  • type (table) - Entity class as a table (not an instance)

Method: createEntity

lua
function SectorScene:createEntity() end

Returns:

  • integer - new entity ID

Method: createEntityType

lua
function SectorScene:createEntityType(
    name,
    props
) end

Parameters:

  • name (string) - Name of the entity type to spawn
  • props (table|nil) - Optional properties to pass to onSpawn function

Returns:

  • table - new entity instance

Method: getComponentBounds

lua
function SectorScene:getComponentBounds(
    entityId
) end

Parameters:

  • entityId (integer)

Returns:

Method: getComponentCollisionShape

lua
function SectorScene:getComponentCollisionShape(
    entityId
) end

Parameters:

  • entityId (integer)

Returns:

Method: getComponentGrid

lua
function SectorScene:getComponentGrid(
    entityId
) end

Parameters:

  • entityId (integer)

Returns:

Method: getComponentIcon

lua
function SectorScene:getComponentIcon(
    entityId
) end

Parameters:

  • entityId (integer)

Returns:

Method: getComponentLabel

lua
function SectorScene:getComponentLabel(
    entityId
) end

Parameters:

  • entityId (integer)

Returns:

Method: getComponentModel

lua
function SectorScene:getComponentModel(
    entityId
) end

Parameters:

  • entityId (integer)

Returns:

Method: getComponentNetwork

lua
function SectorScene:getComponentNetwork(
    entityId
) end

Parameters:

  • entityId (integer)

Returns:

Method: getComponentPathfinding

lua
function SectorScene:getComponentPathfinding(
    entityId
) end

Parameters:

  • entityId (integer)

Returns:

Method: getComponentPlayerControl

lua
function SectorScene:getComponentPlayerControl(
    entityId
) end

Parameters:

  • entityId (integer)

Returns:

Method: getComponentRigidBody

lua
function SectorScene:getComponentRigidBody(
    entityId
) end

Parameters:

  • entityId (integer)

Returns:

Method: getComponentRigidBody

lua
function SectorScene:getComponentRigidBody(
    entityId
) end

Parameters:

  • entityId (integer)

Returns:

Method: getComponentShip

lua
function SectorScene:getComponentShip(
    entityId
) end

Parameters:

  • entityId (integer)

Returns:

Method: getComponentTransform

lua
function SectorScene:getComponentTransform(
    entityId
) end

Parameters:

  • entityId (integer)

Returns:

Method: patchComponentBounds

lua
function SectorScene:patchComponentBounds(
    entityId
) end

Parameters:

  • entityId (integer)

Method: patchComponentCollisionShape

lua
function SectorScene:patchComponentCollisionShape(
    entityId
) end

Parameters:

  • entityId (integer)

Method: patchComponentGrid

lua
function SectorScene:patchComponentGrid(
    entityId
) end

Parameters:

  • entityId (integer)

Method: patchComponentIcon

lua
function SectorScene:patchComponentIcon(
    entityId
) end

Parameters:

  • entityId (integer)

Method: patchComponentLabel

lua
function SectorScene:patchComponentLabel(
    entityId
) end

Parameters:

  • entityId (integer)

Method: patchComponentModel

lua
function SectorScene:patchComponentModel(
    entityId
) end

Parameters:

  • entityId (integer)

Method: patchComponentNetwork

lua
function SectorScene:patchComponentNetwork(
    entityId
) end

Parameters:

  • entityId (integer)

Method: patchComponentPathfinding

lua
function SectorScene:patchComponentPathfinding(
    entityId
) end

Parameters:

  • entityId (integer)

Method: patchComponentPlayerControl

lua
function SectorScene:patchComponentPlayerControl(
    entityId
) end

Parameters:

  • entityId (integer)

Method: patchComponentRigidBody

lua
function SectorScene:patchComponentRigidBody(
    entityId
) end

Parameters:

  • entityId (integer)

Method: patchComponentRigidBody

lua
function SectorScene:patchComponentRigidBody(
    entityId
) end

Parameters:

  • entityId (integer)

Method: patchComponentShip

lua
function SectorScene:patchComponentShip(
    entityId
) end

Parameters:

  • entityId (integer)

Method: patchComponentTransform

lua
function SectorScene:patchComponentTransform(
    entityId
) end

Parameters:

  • entityId (integer)

Method: removeEntity

lua
function SectorScene:removeEntity(
    entityId
) end

Parameters:

  • entityId (integer)

Field declarations

Field: physics

Type: PhysicsDynamicsWorld