package snipe.server.data

class UserLogicNodeCore

User node class. Nodes are described in detail in Nodes article.

Fields

read only id:Int

Node ID.

read only info:LogicNodeCore

Node info shortcut.

Methods

check ():String

Checks if this node is ready to be exited or timed out.

Returns:

Operation error code: ok - all conditions are met, node can be completed. notCompleted - some conditions are not met. failure - timed node failure due to completion timer.

dump ():Dynamic

Stores user logic state into an anonymous object for client response.

Returns:

Anonymous object with user node parameters.

exit (isSuccess:Bool):Void

getInt (name:String):Int

Returns current value of node variable as Int.

Parameters:

name

Variable name.

Returns:

Variable value. Returns 0, if variable is not found.

inline increaseVar (name:String, amount:Int):Void

Increases node variable by a given value. Does not take variable type into account, so do not define node variables with the same name.

Parameters:

name

Variable name.

amount

Amount to increase by.

setVar (id:String, val:Dynamic, ?isInit:Bool):Void

Sets node variable to a given value.

Parameters:

id

Variable id.

val

Variable value.

isInit

Used when called from init() method to skip marking block as updated. Do not use.

timerCompleted ():Bool

Returns whether completion timer is over for this node.

Returns:

True, when the timer is over.