sm.event.sendToScriptableObject

Sends an event to a specified ScriptableObject.

Kind: Function

Environments: Game

Game

sm.event.sendToScriptableObject(
    scriptableObject,
    callback,
    args,
    eventType,
    pauseSave
)

Open the full Game reference

Parameters:

Name Type Description
scriptableObject ScriptableObject The scriptableObject.
callback string The function name in a scriptableObject script.
args (optional) any Optional arguments to be sent to the callback.
eventType (optional) integer The type of event. Defaults to sm.event.types.validate.
pauseSave (optional) boolean Optional, defaults to true. If true, pauses saving for 1 tick for delayed event types (server only).

Returns:

Name Type Description
result boolean Returns true if the event was successfully processed.