API:RemoveTargetEffect

UI Lua API · Effect functions
Version: WAR 1.4.8

Asks the server to remove an effect from a member of the player's group.

RemoveTargetEffect(groupMemberIndex, effectIndex)

Arguments

groupMemberIndex

number – Position of the group member, 1 to 5.

effectIndex

number – Index of the effect on that member.

Returns

Nothing.

Details

• Values of groupMemberIndex outside 1–5 are ignored and nothing is sent.
• The client looks up the object ID of the group member at that position and sends a "remove target effect" request with that ID and effectIndex. Only the low 8 bits of effectIndex are sent.
• The client does not check that the position is occupied or that the effect can be removed.
• The function needs at least two arguments and only reads the last two.
• The stock UI never calls this function.

Errors

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

Example

A minimal call built from the signature:

RemoveTargetEffect( 2, effectIndex )

See also

• RemoveEffect