func_animate

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

Object that changes animation when triggered.

Keys

Key	Type	Default	Description
anim	var		anim to play when triggered. (unless 'num_anims' is set)
start_anim	var		anim to play when first spawned. anim will loop until triggered.
num_anims	var		the number of anims to play in sequence. trigger entity to start next anim. set anims using 'anim1', 'anim2', 'anim3', etc. Triggers targets when done playing animl.
blend_in	var	0	how long to transition from the start_anim to the triggered anim.
wait	var	-1	how long to wait before auto activating. -1 means only activate when triggered.
cycle	var	1	how many times to play the animation after being triggered (use -1 for infinite).
remove	bool		set to 1 to remove object when animation finishes.
target	var		all entities with a matching name will be used after anim plays.
hide	bool		if 1, object remains hidden until triggered. doesn't work when 'start_anim' is set.
sound_bone	var	origin	Bone to play sounds from.
loop_last_anim	var		Loops the last anim when 'num_anims' is set. the next trigger will cause the entity to hide, or be removed if 'remove' is set.
auto_advance	var		When 'num_anims' is set, won't wait to be triggered between each anim.

Editor

Property	Value
Type	point entity
Spawn class	idAnimated -> idAFEntity_Gibbable -> idAFEntity_Base -> idAnimatedEntity -> idEntity -> idClass
Min	-16 -16 0
Max	16 16 32
Color	1 .5 .3

Script events

Event	Declared by
activate	idAnimated
startRagdoll	idAnimated
footstep	idAnimated
leftFoot	idAnimated
rightFoot	idAnimated
launchMissiles	idAnimated
setAnimation	idAnimated
getAnimationLength	idAnimated
gib	idAFEntity_Gibbable
SetConstraintPosition	idAFEntity_Base
getJointHandle	idAnimatedEntity
clearAllJoints	idAnimatedEntity
clearJoint	idAnimatedEntity
setJointPos	idAnimatedEntity
setJointAngle	idAnimatedEntity
getJointPos	idAnimatedEntity
getJointAngle	idAnimatedEntity
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

Object that changes animation when triggered.

Keys

Key	Type	Default	Description
anim	var		anim to play when triggered. (unless 'num_anims' is set)
start_anim	var		anim to play when first spawned. anim will loop until triggered.
num_anims	var		the number of anims to play in sequence. trigger entity to start next anim. set anims using 'anim1', 'anim2', 'anim3', etc. Triggers targets when done playing animl.
blend_in	var	0	how long to transition from the start_anim to the triggered anim.
wait	var	-1	how long to wait before auto activating. -1 means only activate when triggered.
cycle	var	1	how many times to play the animation after being triggered (use -1 for infinite).
remove	bool		set to 1 to remove object when animation finishes.
target	var		all entities with a matching name will be used after anim plays.
hide	bool		if 1, object remains hidden until triggered. doesn't work when 'start_anim' is set.
sound_bone	var	origin	Bone to play sounds from.
loop_last_anim	var		Loops the last anim when 'num_anims' is set. the next trigger will cause the entity to hide, or be removed if 'remove' is set.
auto_advance	var		When 'num_anims' is set, won't wait to be triggered between each anim.
scriptObject	var		specifies a script object to run an animation state loop with, this overrides all other animation functionality

Editor

Property	Value
Type	point entity
Spawn class	idAnimated -> idAFEntity_Gibbable -> idAFEntity_Base -> idAnimatedEntity -> idEntity -> idClass
Min	-16 -16 0
Max	16 16 32
Color	1 .5 .3

Script events

Event	Declared by
activate	idAnimated
startRagdoll	idAnimated
footstep	idAnimated
leftFoot	idAnimated
rightFoot	idAnimated
launchMissiles	idAnimated
setAnimState	idAnimated
playAnim	idAnimated
playCycle	idAnimated
animDone	idAnimated
gib	idAFEntity_Gibbable
SetConstraintPosition	idAFEntity_Base
getJointHandle	idAnimatedEntity
clearAllJoints	idAnimatedEntity
clearJoint	idAnimatedEntity
setJointPos	idAnimatedEntity
setJointAngle	idAnimatedEntity
getJointPos	idAnimatedEntity
getJointAngle	idAnimatedEntity
setJointAngularVelocity	idAnimatedEntity
collapseJoints	idAnimatedEntity
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
clearSkin	idEntity
setContents	idEntity
getLastBlocker	idEntity
playEffect	idEntity
stopEffect	idEntity
stopAllEffects	idEntity
getHealth	idEntity
hideSurface	idEntity
showSurface	idEntity
guiEvent	idEntity
playbackCallback	idEntity
getBindMaster	idEntity
applyImpulse	idEntity
removeNullTargets	idEntity
isA	idEntity
isSameTypeAs	idEntity
matchPrefix	idEntity
clearTargetList	idEntity
appendTarget	idEntity
removeTarget	idEntity
setHealth	idEntity
remove	idClass

Prey

Object that changes animation when triggered.

Keys

Key	Type	Default	Description
anim	var	idle	anim to play when triggered.
defaultPose	var		anim to use to pose model when first spawned. pose_frame sets the frame. Model does not animate until triggered.
pose_frame	var	1	which frame to use when spawning with a static pose.
start_anim	var		anim to play when first spawned. anim will loop until triggered.
blend_in	var	0	how long to transition from the 'defaultAnim' to the triggered 'anim'
wait	var	-1	how long to wait before auto activating. -1 means only activate when triggered.
cycle	var	1	how many times to play the animation after being triggered (use -1 for infinite).
remove	bool		set to 1 to remove object when animation finishes.
target	var		all entities with a matching name will be used after anim plays.
hide	bool		if 1, object remains hidden until triggered.
sound_bone	var	origin	Bone to play sounds from.
resetDefaultAnim	bool	0	restarts start anim after anim is done

Editor

Property	Value
Type	point entity
Spawn class	hhAnimated -> idAnimated -> idAFEntity_Gibbable -> idAFEntity_Base -> hhAnimatedEntity -> idAnimatedEntity -> hhRenderEntity -> idEntity -> idClass
Min	-16 -16 -1
Max	16 16 32
Color	0.3 0.3 0.75

Script events

Event	Declared by
activate	hhAnimated
setAnim	hhAnimated
isAnimDone	hhAnimated
footstep	hhAnimated
leftFoot	hhAnimated
rightFoot	hhAnimated
startRagdoll	idAnimated
launchMissiles	idAnimated
gib	idAFEntity_Gibbable
SetConstraintPosition	idAFEntity_Base
setAFCollision	idAFEntity_Base
spawnFXAlongBone	hhAnimatedEntity
getJointHandle	idAnimatedEntity
clearAllJoints	idAnimatedEntity
clearJoint	idAnimatedEntity
setJointPos	idAnimatedEntity
setJointAngle	idAnimatedEntity
getJointPos	idAnimatedEntity
getJointAngle	idAnimatedEntity
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