Space Types
EnableCollaborationAction
An event that is used to enable collaboration features.
Members
playerId? string
The ID of the player that created this task. Set by remote action handlers when a task is recieved from a remote player.
taskId (string | number)
The ID of the async task.
type "enable_collaboration"
The type of the event. This helps determine how the event should be applied to the state.
uncopiable? boolean
Whether the action can be structure cloned. If true, then the action should not be passed across message ports without special handling.
InstConfig
The configuration for loading an inst.
Members
inst? string
The inst that should be loaded.
When specified, you can also use the owner field to specify where the inst should be loaded from.
owner? string
The owner of the inst.
Possible values are:
- "public" - The inst is public and temporary.
- "player" - The inst is owned by the current player.
- Any record name - the inst will be loaded from the given record.
- Any user ID - the inst will be loaded from the given user's default record.
- Any studio ID - the inst will be loaded from the given studio's default record.
Only valid when an inst is also specified.
record? string
The record that the inst should be loaded from.
Only valid when an inst is also specified.
staticInst? string
The static inst that should be loaded.
Only valid when specified on its own.
LoadInstConfigAction
An event that is used to load an inst.
Members
config InstConfig
The config that should be used to load the inst.
type "load_server_config"
uncopiable? boolean
Whether the action can be structure cloned. If true, then the action should not be passed across message ports without special handling.
LoadSpaceAction
Defines an event that loads a space into the instance.
Members
config any
The config that should be used to load the space.
playerId? string
The ID of the player that created this task. Set by remote action handlers when a task is recieved from a remote player.
taskId? (string | number)
The ID of the async task.
type "load_space"
uncopiable? boolean
Whether the action can be structure cloned. If true, then the action should not be passed across message ports without special handling.
UnloadInstConfigAction
An event that is used to unload a simulation.
Members
config InstConfig
The config that should be used to unload the inst.
type "unload_server_config"
uncopiable? boolean
Whether the action can be structure cloned. If true, then the action should not be passed across message ports without special handling.