API:UseEffect

UI Lua API · Effect functions
Version: WAR 1.4.8

Sends a "use effect" request for one of the player's effects to the server.

UseEffect(effectIndex)

Arguments

effectIndex

number – Index of the effect.

Returns

Nothing.

Details

• Sends a "use effect" request with effectIndex to the server. Only the low 8 bits of the value are sent (0–255).
• The client does not check the value. What the request does is decided by the server.
• Exactly one argument must be passed.
• The stock UI never calls this function.

Errors

None besides the generic Invalid Parameters message when the argument is missing or not a number.

Example

A minimal call built from the signature:

UseEffect( effectIndex )

See also

• RemoveEffect