Called when an object enters the zone
Called when the zone is destroyed
Called when an object leaves the zone
Called every tick.
Destroy the zone
Return the zone's color, including its alpha value
Return which cursors are hidden from other players while in the zone, as defined by ZonePermission
Return the zone's unique id
Return which players are allowed to insert into containers in the zone, as defined by ZonePermission
Return which players are allowed to interact with objects in the zone, as defined by ZonePermission
Return for which players objects in the zone are visible, as defined by ZonePermission
Return all objects in the zone. Any object that touches a zone is considered to be in it.
Return a list of the owning player slots of the zone
Return the zone's position
Return the zone's rotation
Return data that was stored using setSavedData or loaded from a saved state.
Return the zone's scale
Return the shape of the zone, as defined by ZoneShape
Return which players are allowed to snap objects in the zone, as defined by ZonePermission
Return which players are allowed to stack cards in the zone, as defined by ZonePermission
Return whether the zone is visible when players are not in zone mode
Return whether an object overlaps the zone. Any object that touches a zone is considered to be in it.
The object to check for an overlap
Return whether a given player slot is an owner of the zone
Return whether the zone is valid. A zone becomes invalid after it has been destroyed or deleted by a player
Set whether the zone is visible when players are not in zone mode
The new color
Set the zone's color
The new color. The alpha channel determines the zone's translucency. It can't be lower than 0.1, zone translucency will not be updated if the alpha channel is below 0.1
Set which cursors are hidden from other players while in the zone
The new permission, as defined by ZonePermission
Set the zone's unique id. Returns whether the id was changed successfully. Fails if the id is already used by another zone.
Set which players are allowed to insert into containers in the zone
The new permission, as defined by ZonePermission
Set which players are allowed to interact with objects in the zone
The new permission, as defined by ZonePermission
Set for which players objects in the zone are visible
The new permission, as defined by ZonePermission
Set the zone's position.
The new position
Set the zone's rotation.
The new rotation
Set the data that will be stored in save game states. The data is available using getSavedData when the object script is run after loading a save state. Try to keep this data small and don't change it frequently, it needs to be sent over the network to all clients.
Data to store, maximum length 1023 characters
Set the zone's scale. At scale 1 the size is 1cm in each direction, so the scale also corresponds to the size in cm.
The new scale
Set the shape of the zone
The new shape, as defined by ZoneShape
Set whether a player slot is an owner of the zone
Set which players are allowed to snap objects in the zone
The new permission, as defined by ZonePermission
Set which players are allowed to stack cards in the zone
The new permission, as defined by ZonePermission
An zone that changes game behavior in a defined part of the playing area