AreaTrigger

Availability

Server + Client

Serializable

No

Associated namespace

sm.areaTrigger

A userdata object representing an area trigger in the game.

Values:

• id [ integer ]
  

  • Get: Returns the id of an area trigger.

• world [ World ]
  

  • Get: Returns the world id of the area trigger. Keep in mind that area triggers can move between worlds, so world id might change!
    Result: The current world id of the area trigger.

Operations:

Server + Client

bindOnDestroy

areaTrigger:bindOnDestroy( callback, object )

Bind the lua function to be called when the area trigger is destroyed

Parameters:

bindOnEnter

areaTrigger:bindOnEnter( callback, object )

Binds an area trigger's onEnter event to a custom callback. The onEnter event is triggered when an object enters the trigger area.

The callback receives:

• self (table) – The class instance.
• trigger (AreaTrigger) – The area trigger instance.
• results (table) – A table of characters and/or bodies and/or harvestables and/or lifts and/or areaTriggers.

function MyClass.onEnter( self, trigger, results ) ...

Parameters:

bindOnExit

areaTrigger:bindOnExit( callback, object )

Binds an area trigger's onExit event to a custom callback. The onExit event is triggered when an object leaves the trigger area.

The callback receives:

• self (table) – The class instance.
• trigger (AreaTrigger) – The area trigger instance.
• results (table) – A table of characters and/or bodies and/or harvestables and/or lifts and/or areaTriggers.

function MyClass.onExit( self, trigger, results ) ...

Parameters:

bindOnHostDestroy

areaTrigger:bindOnHostDestroy( callback, object )

Bind the lua function to be used when an area trigger is destroyed.

Parameters:

bindOnHostUnload

areaTrigger:bindOnHostUnload( callback, object )

Bind the lua function to be used when an interactable area trigger's host object is unloaded.

Note: Only the game host can know if a host object is unloaded, to a connected client it will look like the host object was destroyed.

Parameters:

bindOnProjectile

areaTrigger:bindOnProjectile( callback, object )

Binds an area trigger's onProjectile event to a custom callback. The onProjectile event is triggered if a projectile collides with the trigger area

Parameters:

bindOnStay

areaTrigger:bindOnStay( callback, object )

Binds an area trigger's onStay event to a custom callback. The onStay event is triggered every tick as long as an object is staying inside of the trigger area.

The callback receives:

• self (table) – The class instance.
• trigger (AreaTrigger) – The area trigger instance.
• results (table) – A table of characters and/or bodies and/or harvestables and/or lifts and/or areaTriggers.

function MyClass.onStay( self, trigger, results ) ...

Parameters:

destroy

areaTrigger:destroy(  )

Destroys an area trigger.

Parameters:

getCharacters

areaTrigger:getCharacters(  )

Gets the trigger collisions for characters inside the area trigger

Parameters:

Returns:

getContents

areaTrigger:getContents(  )

Gets the contents of the area trigger.

Returns a table of characters and/or bodies and/or harvestables and/or lifts and/or areaTriggers.

Parameters:

Returns:

getHarvestables

areaTrigger:getHarvestables(  )

Gets the trigger collisions for harvestables inside the area trigger

Parameters:

Returns:

getHostInteractable

areaTrigger:getHostInteractable(  )

Returns the attached host Interactable.

Parameters:

Returns:

getId

areaTrigger:getId(  )

Returns the id of an area trigger.

Parameters:

Returns:

getShapes

areaTrigger:getShapes(  )

Gets the trigger collisions for shapes inside the area trigger

Will only return one Shape for each Body that is colliding with the AreaTrigger.

Parameters:

Returns:

getSize

areaTrigger:getSize(  )

Returns the size of an area trigger.

Parameters:

Returns:

getUserData

areaTrigger:getUserData(  )

Returns the user data set on the area trigger.

Parameters:

Returns:

getWorld

areaTrigger:getWorld(  )

Returns the world id of the area trigger. Keep in mind that area triggers can move between worlds, so world id might change!

Parameters:

Returns:

getWorldMax

areaTrigger:getWorldMax(  )

Returns the world max corner position of an area trigger.

Parameters:

Returns:

getWorldMin

areaTrigger:getWorldMin(  )

Returns the world min corner position of an area trigger.

Parameters:

Returns:

getWorldPosition

areaTrigger:getWorldPosition(  )

Returns the world position of an area trigger.

Parameters:

Returns:

getWorldRotation

areaTrigger:getWorldRotation(  )

Returns the world rotation of an area trigger.

Parameters:

Returns:

hasVoxelTerrainContact

areaTrigger:hasVoxelTerrainContact(  )

Returns true if the AreaTrigger is in contact with destructable terrain.

Parameters:

Returns:

setCharacterDetection

areaTrigger:setCharacterDetection( detectCharacters )

When set to true the area trigger can calculate which characters are inside of the trigger and get the collision information.

with a call to AreaTrigger: getCharacters

Parameters:

setDestroyOnErase

areaTrigger:setDestroyOnErase( destroyOnErase )

Sets whether the areatrigger should be destroyed immediately upon being erased or simply invoke the bound OnErase callback. True by default.

Parameters:

setEraseTime

areaTrigger:setEraseTime( eraseTime )

Sets the time it takes to erase this trigger if it is erasable.

Parameters:

setHarvestableDetection

areaTrigger:setHarvestableDetection( detectHarvestables )

When set to true the area trigger can calculate which harvestables are inside of the trigger and get the collision information.

with a call to AreaTrigger: getHarvestables

Parameters:

setIncludeShapesInContent

areaTrigger:setIncludeShapesInContent( includeShapesInContent )

When set to true the area trigger will include individual shapes in its content list.

Parameters:

setShapeDetection

areaTrigger:setShapeDetection( detectShapes )

Shape detection is off by default. When set to true the area trigger can calculate which shapes are inside of the trigger

with a call to AreaTrigger: getShapes

Parameters:

setSize

areaTrigger:setSize( size )

Sets the new size of an area trigger.

Parameters:

setVoxelDestructible

areaTrigger:setVoxelDestructible( destructible )

Sets whether VoxelTerrain can destroy this area trigger by voxel addition.

Parameters:

setWaterType

areaTrigger:setWaterType( waterType )

Sets the liquid type of the area trigger. (See sm.areaTrigger.liquidType)

Only has an effect on area triggers with the 'water' proxy type; setting it on any other proxy type has no effect.

Currently only 'lava' has special behavior: it occasionally destroys submerged shapes. Lava behavior requires

shapes to be included in the content list via AreaTrigger: setIncludeShapesInContent.

Parameters:

setWorldPosition

areaTrigger:setWorldPosition( position )

Sets the new world position of an area trigger.

Parameters:

setWorldRotation

areaTrigger:setWorldRotation( rotation )

Sets the new world rotation of an area trigger.

Parameters:

Server-only

bindOnMelee

areaTrigger:bindOnMelee( callback, object )

Bind the lua function to be used when the area trigger is hit by a melee attack.

Requires that areaTriggerProxyType has been set to sm.areaTrigger.areaTriggerProxyType.melee

Parameters:

Client-only

bindCanErase

areaTrigger:bindCanErase( callback, object )

Bind a callback that checks if the area trigger can be erased.

Parameters:

bindCanInteract

areaTrigger:bindCanInteract( callback, object )

Bind the lua function to be used when checking for player interaction with the area trigger

Parameters:

bindOnErase

areaTrigger:bindOnErase( callback, object )

Bind the lua function to be used when an interactable area trigger is erased.

Parameters:

bindOnInteract

areaTrigger:bindOnInteract( callback, object )

Bind the lua function to be used when a player interacts with an area trigger

Parameters: