# Status Decrement

Grammar — StatusDecrement statusVariable
FlagsFunction

Constructs and returns a StatusDecrement actor message. This message is used to decrement an existing status variable, specified by the Status Variable parameter, on an actor. If the status variable count is 0 a StatusOff message tied to that status variable is sent to the actor, which would respond in a pre-determined fashion to no longer having that status. Note: This is a relatively advanced actor concept, as it requires an actor be setup to respond to a StatusOn or StatusOff message to have any effect.

# Arguments

  • string — Status Variable

Returns — string<actormsg>

string libNtve_gf_StatusDecrement(
	string lp_statusVariable,
);

Category: Actor / Message Constructors

# Examples

— None found —