ScriptEvent:playMaterialEffectMaxVisDist

Parameters

string key -- Key to look up the effect from.
vector color -- RGB color components.
string joint -- Name of the joint to play the effect on.
string surfacetype -- surfaceType to look up any special effect from.
boolean loop -- Whether the effect should be once only, or loop.
float maxVisDist -- Maximum distance the effect will be visible from.
boolean isStatic -- Whether the particle effect is static or not

Result

handle

Supported By

idEntity

Comments

• If no joint is specified, the joint cannot be found, or the entity does not support animated models, 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. If a special version matching that of the surfaceType passed is found, that will be played, otherwise the exact key name will be used.