ScriptEvent:playJointEffectViewSuppress

Parameters

string key -- Key to look up the effect from.
integer joint -- Index of the joint to play the effect on.
boolean loop -- Whether the effect should be once only, or loop.
boolean viewSuppress -- If set, the effect will inherit the view suppress setting from this entity, otherwise it will have no view supress settings.

Result

handle

Supported By

idEntity

Comments

• If the joint is invalid, the effect will be played at the entity's origin.
• The key must start with 'fx_'.

Functionality

Looks up an effect on the entity and plays it at the specified joint, and returns a handle to the effect.