Module event

Module event 

Source
Expand description

Event handlers and event types for scripting.

Structs§

CallbackLabel
A string which disallows common invalid characters in callback labels, particularly at the start of the string
ForPlugin
Wrapper around a script event making it available to read by a specific plugin only
OnScriptLoaded
Fired when a script is successfully loaded A callback label for the event: “on_script_loaded”
OnScriptReloaded
Fired when a script is reloaded (loaded after being unloaded) This callback receives the value returned by the on_script_unloaded callback if any were returned A callback label for the event: “on_script_reloaded”
OnScriptUnloaded
Fired when a script is unloaded before a reload, if a value is returned, it will be passed to the on_script_reloaded callback A callback label for the event: “on_script_unloaded”
ScriptAssetModifiedEvent
Emitted when a script asset is modified and all its attachments require re-loading
ScriptAttachedEvent
Emitted when a script is attached.
ScriptCallbackEvent
A callback event meant to trigger a callback in a subset/set of scripts in the world with the given arguments
ScriptCallbackResponseEvent
Event published when a script completes a callback and a response is requested.
ScriptDetachedEvent
Emitted when a script is detached.
ScriptErrorEvent
An error coming from a script

Enums§

Recipients
Describes the designated recipients of a script event

Traits§

IntoCallbackLabel
A trait for types that can be converted into a callback label