sm.event.sendToWorld
Sends an event to a specified World.
Kind: Function
Environments: Game
Game
sm.event.sendToWorld( world, callback, args, eventType, pauseSave )
Parameters:
| Name | Type | Description |
|---|---|---|
world |
World | The world. |
callback |
string | The function name in a world 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. |