ScriptEvent:playMaterialEffect

Parameters

string key -- Key to look up the effect name from.
vector color -- RGB color components.
string joint -- Name of the joint to play the effect on.
string material -- Material type to look up any special effect from.
integer loop -- Whether the effect should be once only, or loop.

Result

handle -- Handle to the spawned effect.

Supported By

sdClientScriptEntity
idEntity

Comments

• If the joint cannot be found, the effect will play 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. If a special version matching that of the material passed is found, that will be played, otherwise the exact key name will be used.