func_fx

This is an entity on id Tech 4 engines, present on DOOM 3, Quake 4 and Prey. Below you can find its spawnflags, keys and editor settings for each game that defines it.

DOOM 3

Spawns a special effect when triggered.

Keys

Key	Type	Default	Description
fx	var		the .fx file to spawn when triggered
restart	var		Once triggered, how often do you want it to re-trigger itself ? (usefull for fx/sparks.fx)
triggered	var		Start effect when triggered.
start	var		If set, starts effect as soon as it's spawned (unless 'triggered' is set)

Editor

Property	Value
Type	point entity
Spawn class	idEntityFx -> idEntity -> idClass
Min	-8 -8 -8
Max	8 8 8
Color	0 .5 .8

Script events

Event	Declared by
activate	idEntityFx
_killfx	idEntityFx
getName	idEntity
setName	idEntity
activateTargets	idEntity
numTargets	idEntity
getTarget	idEntity
randomTarget	idEntity
bindToJoint	idEntity
removeBinds	idEntity
bind	idEntity
bindPosition	idEntity
unbind	idEntity
setOwner	idEntity
setModel	idEntity
setSkin	idEntity
getShaderParm	idEntity
setShaderParm	idEntity
setShaderParms	idEntity
setColor	idEntity
getColor	idEntity
isHidden	idEntity
hide	idEntity
show	idEntity
cacheSoundShader	idEntity
startSoundShader	idEntity
startSound	idEntity
stopSound	idEntity
fadeSound	idEntity
getWorldOrigin	idEntity
setWorldOrigin	idEntity
getOrigin	idEntity
setOrigin	idEntity
getAngles	idEntity
setAngles	idEntity
getLinearVelocity	idEntity
setLinearVelocity	idEntity
getAngularVelocity	idEntity
setAngularVelocity	idEntity
getSize	idEntity
setSize	idEntity
getMins	idEntity
getMaxs	idEntity
touches	idEntity
setGuiParm	idEntity
setGuiFloat	idEntity
getNextKey	idEntity
setKey	idEntity
getKey	idEntity
getIntKey	idEntity
getFloatKey	idEntity
getVectorKey	idEntity
getEntityKey	idEntity
restorePosition	idEntity
distanceTo	idEntity
distanceToPoint	idEntity
startFx	idEntity
waitFrame	idEntity
wait	idEntity
hasFunction	idEntity
callFunction	idEntity
setNeverDormant	idEntity
setGui	idEntity
precacheGui	idEntity
getGuiParm	idEntity
getGuiParmFloat	idEntity
guiNamedEvent	idEntity
remove	idClass

Quake 4

Spawns a special effect when triggered.

Keys

Key	Type	Default	Description
fx	var		the .fx file to spawn when triggered
restart	var		Once triggered, how often do you want it to re-trigger itself ? (usefull for fx/sparks.fx)
triggered	var		Start effect when triggered.
start	var		If set, starts effect as soon as it's spawned (unless 'triggered' is set)

Editor

Property	Value
Type	point entity
Spawn class	idEntityFx
Min	-8 -8 -8
Max	8 8 8
Color	0 .5 .8

Prey

Spawns a special effect when triggered.

Keys

Key	Type	Default	Description
fx	var		the .fx file to spawn when triggered
removeWhenDone	bool		fx gets removed when duration is exceeded
toggle	bool		fx will toggle on/off when triggered, default is 0
restart	var		>= 1 will make the fx automatically restart itself. The delay before restarting is 'restartDelay' + a random value between 0 and this number. The fx will automatically start unless 'deferredRestart' is set.
triggered	var		Start effect when triggered.
start	var		If set, starts effect as soon as it's spawned (unless 'triggered' is set)
restartDelay	var		If 'restart' is set, this value is added to the random restart time.
deferredRestart	var		If 'restart' is set, this will prevent the fx from automatically starting.

Editor

Property	Value
Type	point entity
Spawn class	hhEntityFx -> idEntityFx -> idEntity -> idClass
Min	-8 -8 -8
Max	8 8 8
Color	0 .5 .8

Script events

Event	Declared by
activate	hhEntityFx
_killfx	hhEntityFx
moveToJoint	idEntity
moveToJointWeighted	idEntity
moveJointToJoint	idEntity
moveJointToJointOffset	idEntity
setSkin	idEntity
spawnDebris	idEntity
delayDamageEntity	idEntity
dispose	idEntity
setDeformation	idEntity
setFloatKey	idEntity
setVectorKey	idEntity
setEntityKey	idEntity
playerCanSee	idEntity
setContents	idEntity
setClipmask	idEntity
setPortalCollision	idEntity
killbox	idEntity
getName	idEntity
setName	idEntity
findTargets	idEntity
activateTargets	idEntity
numTargets	idEntity
getTarget	idEntity
randomTarget	idEntity
bindToJoint	idEntity
removeBinds	idEntity
bind	idEntity
bindPosition	idEntity
unbind	idEntity
setOwner	idEntity
setModel	idEntity
getShaderParm	idEntity
setShaderParm	idEntity
setShaderParms	idEntity
setColor	idEntity
getColor	idEntity
isHidden	idEntity
hide	idEntity
show	idEntity
cacheSoundShader	idEntity
startSoundShader	idEntity
startSound	idEntity
stopSound	idEntity
fadeSound	idEntity
getWorldOrigin	idEntity
setWorldOrigin	idEntity
getOrigin	idEntity
setOrigin	idEntity
getAngles	idEntity
setAngles	idEntity
getLinearVelocity	idEntity
setLinearVelocity	idEntity
getAngularVelocity	idEntity
setAngularVelocity	idEntity
getSize	idEntity
setSize	idEntity
getMins	idEntity
getMaxs	idEntity
touches	idEntity
setGuiParm	idEntity
setGuiFloat	idEntity
getNextKey	idEntity
setKey	idEntity
getKey	idEntity
getIntKey	idEntity
getFloatKey	idEntity
getVectorKey	idEntity
getEntityKey	idEntity
restorePosition	idEntity
updateCameraTarget	idEntity
distanceTo	idEntity
distanceToPoint	idEntity
startFx	idEntity
waitFrame	idEntity
wait	idEntity
hasFunction	idEntity
callFunction	idEntity
setNeverDormant	idEntity
playRumble	idEntity
stopRumble	idEntity
remove	idClass