This module is a wrapper for snipe.kit.game.modules.ActionModule
providing limited functionality to call action scripts from within other action scripts.
It is available only on Snipe Kit server.
custom (actionID:String, ?actionParams:Dynamic):Dynamic
Calls "game.custom" action script directly.
Will only work from inside of other action scripts on the user given to the parent script.
Script usage example:
// call script
server.actions.custom('chest.pre');
Parameters:
actionID
User action ID. Must have "game.custom" trigger.
actionParams
(optional) User action parameters object.
Returns:
Action result object. Has to have "errorCode" string field.
include (actionID:String, ?actionParams:Dynamic):Dynamic
Calls "any.include" action script directly and returns results to caller script.
Script usage example:
server.actions.include('chest.pre');
Parameters:
actionID
Action ID. Must have "any.include" trigger.
actionParams
(optional) Action parameters object.
Returns:
Action result object. In case of error has a field "errorCode".
remoteRoomEvent (userID:Int, actionID:String, ?actionParams:Dynamic):{errorCode:String}
Calls a remote room event on a room server that this user is in.
Note: At the time of call no checks are made to see if the user is in a room. Any issues on the remote end will not be returned in this call.
Error codes:
ok
- Operation successful.notInRoomServer
- This user is not in a room server.Parameters:
userID
User ID.
actionID
User action ID. Must have "room.event" trigger.
actionParams
Optional. User action parameters object. Can be null.
Returns:
Action result object. Has "errorCode" field.