LUADOC - Farming Simulator 17

Printable Version

ParticleUtil

Description
ParticleUtil
Functions

loadParticleSystem

Description
Load particle system
Definition
loadParticleSystem(integer xmlId, table particleSystem, string baseString, table linkNodes, boolean defaultEmittingState, string defaultPsFile, string baseDir, integer defaultLinkNode)
Arguments
integerxmlIdid of xml file
tableparticleSystemtable to add particle system data
stringbaseStringbase string to load data from xml
tablelinkNodeslink nodes
booleandefaultEmittingStatedefault emitting state
stringdefaultPsFilepath to default ps file
stringbaseDirbase directory
integerdefaultLinkNodeid of default link node

deleteParticleSystem

Description
Delete particle system
Definition
deleteParticleSystem(table particleSystem)
Arguments
tableparticleSystemparticle system

deleteParticleSystems

Description
Delete particle systems
Definition
deleteParticleSystems(table particleSystems)
Arguments
tableparticleSystemsparticle systems

setEmittingState

Description
Set emitting state of particle system
Definition
setEmittingState(table particleSystem, boolean state, boolean resetStartTimer, boolean resetStopTimer)
Arguments
tableparticleSystemparticle system
booleanstateemitting state
booleanresetStartTimerreset start timer
booleanresetStopTimerreset stop timer

getParticleSystemAverageSpeed

Description
Returns average speed of particle system
Definition
getParticleSystemAverageSpeed(table particleSystem)
Arguments
tableparticleSystemparticle system
Return Values
floataverageSpeedaverage speed

setParticleSystemTimeScale

Description
Setting time scale of particle system
Definition
setParticleSystemTimeScale(table particleSystem, float scale)
Arguments
tableparticleSystemparticle system
floatscaletime scale

setEmitCountScale

Description
Setting emit count scale of particle system
Definition
setEmitCountScale(table particleSystem, float scale)
Arguments
tableparticleSystemparticle system
floatscaleemit count scale

setParticleLifespan

Description
Setting particle system lifespan
Definition
setParticleLifespan(table particleSystem, float lifespan)
Arguments
tableparticleSystemparticle system
floatlifespanlifespan

setParticleStartStopTime

Description
Sets start and stop time of particle system
Definition
setParticleStartStopTime(table particleSystem, float startTime, float stopTime)
Arguments
tableparticleSystemparticle system
floatstartTimestart time
floatstopTimestop time

getParticleSystemSpeed

Description
Returns speed of particle system
Definition
getParticleSystemSpeed(table particleSystem)
Arguments
tableparticleSystemparticle system
Return Values
floatspeedspeed

setParticleSystemSpeed

Description
Sets speed of particle system
Definition
setParticleSystemSpeed(table particleSystem, float speed)
Arguments
tableparticleSystemparticle system
floatspeedspeed

getParticleSystemSpeedRandom

Description
Returns speed random of particle system
Definition
getParticleSystemSpeedRandom(table particleSystem)
Arguments
tableparticleSystemparticle system
Return Values
floatspeedRandomspeed random

setParticleSystemSpeedRandom

Description
Sets speed random of particle system
Definition
setParticleSystemSpeedRandom(table particleSystem, float speedRandom)
Arguments
tableparticleSystemparticle system
floatspeedRandomspeed random

getParticleSystemNormalSpeed

Description
Returns normal speed of particle system
Definition
getParticleSystemNormalSpeed(table particleSystem)
Arguments
tableparticleSystemparticle system
Return Values
floatnormalSpeednormal speed

setParticleSystemNormalSpeed

Description
Sets normal speed of particle system
Definition
setParticleSystemNormalSpeed(table particleSystem, float normalSpeed)
Arguments
tableparticleSystemparticle system
floatnormalSpeednormal speed

getParticleSystemTangentSpeed

Description
Returns tangent speed of particle system
Definition
getParticleSystemTangentSpeed(table particleSystem)
Arguments
tableparticleSystemparticle system
Return Values
floattangentSpeedtangent speed

setParticleSystemTangentSpeed

Description
Sets tangent speed of particle system
Definition
setParticleSystemTangentSpeed(table particleSystem, float tangentSpeed)
Arguments
tableparticleSystemparticle system
floattangentSpeedtangent speed

getParticleSystemSpriteScaleX

Description
Returns X sprite scale of particle system
Definition
getParticleSystemSpriteScaleX(table particleSystem)
Arguments
tableparticleSystemparticle system
Return Values
floatspriteScaleXX sprite scale

setParticleSystemSpriteScaleX

Description
Sets X sprite scale of particle system
Definition
setParticleSystemSpriteScaleX(table particleSystem, float spriteScaleX)
Arguments
tableparticleSystemparticle system
floatspriteScaleXX sprite scale

getParticleSystemSpriteScaleY

Description
Returns Y sprite scale of particle system
Definition
getParticleSystemSpriteScaleY(table particleSystem)
Arguments
tableparticleSystemparticle system
Return Values
floatspriteScaleYY sprite scale

setParticleSystemSpriteScaleY

Description
Sets Y sprite scale of particle system
Definition
setParticleSystemSpriteScaleY(table particleSystem, float spriteScaleY)
Arguments
tableparticleSystemparticle system
floatspriteScaleYY sprite scale

getParticleSystemSpriteScaleXGain

Description
Returns X sprite scale gain of particle system
Definition
getParticleSystemSpriteScaleXGain(table particleSystem)
Arguments
tableparticleSystemparticle system
Return Values
floatspriteScaleXGainX sprite scale gain

setParticleSystemSpriteScaleXGain

Description
Sets X sprite scale gain of particle system
Definition
setParticleSystemSpriteScaleXGain(table particleSystem, float spriteScaleXGain)
Arguments
tableparticleSystemparticle system
floatspriteScaleXGainX sprite scale gain

getParticleSystemSpriteScaleYGain

Description
Returns Y sprite scale gain of particle system
Definition
getParticleSystemSpriteScaleYGain(table particleSystem)
Arguments
tableparticleSystemparticle system
Return Values
floatspriteScaleYGainY sprite scale gain

setParticleSystemSpriteScaleYGain

Description
Sets Y sprite scale gain of particle system
Definition
setParticleSystemSpriteScaleYGain(table particleSystem, float spriteScaleYGain)
Arguments
tableparticleSystemparticle system
floatspriteScaleYGainY sprite scale gain

resetNumOfEmittedParticles

Description
Resets number of emitted particles
Definition
resetNumOfEmittedParticles(table particleSystem)
Arguments
tableparticleSystemparticle system