Entity/LoadParticleEffect

From Blue Mars Developer Guidebook

Jump to: navigation, search
There are security restrictions on this article


This is an Entity function

Function

LoadParticleEffect(nSlot, sEffectName, params)
Load a particle effect by name into an entity slot (-1 indicates take the next available)
return value - the slot used or -1 if failed
nSlot - entity slot
sEffectName - particle effect name
params - table the effect spawn parameters
example - Golf/Shoot
self.particleSlot = self.ball:LoadParticleEffect(1, "golf_fx.ball_trail_white", {});


Spawn Parameters

bPrime 
boolean - {{{p1doc}}} default - {{{p1default}}}
PulsePeriod 
float - {{{p2doc}}} default - {{{p2default}}}
CountScale 
float - {{{p3doc}}} default - {{{p3default}}}
AttachType 
{{{p4type}}} - {{{p4doc}}} default - {{{p4default}}}
AttachForm 
{{{p5type}}} - {{{p5doc}}} default - {{{p5default}}}
bCountPerUnit 
boolean - {{{p6doc}}} default - {{{p6default}}}


Notes

Use FreeSlot to kill the effect

Problems with this wiki page? Contact us either by: Support Email or Support Ticket System

Blue Mars Guidebook Privacy Policy
Blue Mars Guidebook Community Guidelines

Personal tools