Event Animator

From Serious Sam Wiki
Jump to: navigation, search
Editor model of CEventAnimatorEntity.

General information

Class: CEventAnimatorEntity

The Event animator is used to animate effects, i.e. to increase or reduce effects.

Properties

Simple animator (CSimpleAnimator)

Defines an entity pointer to a simple animator which holds a set of animations. For more information see Simple Animator.


Controlled from script (ENUM)

Defines if the Event animator is controlled from any type of scripting.


Editor size (FLOAT)
SEd4.0 only

Defines the size of the editor model of the Event animator. This has no influence in-game, it just facilitates editing.


Spawn flags (LFLAGS)

Defines in which difficulty levels and game types the Event animator is spawned.


Name (CString)

Defines the name of the Event animator.


Defines a entity pointer to the parent of the Event animator.


Platforms (LFLAGS)

Defines on which platforms the Event animator is spawned.


Entity ID (ULONG)

Displays the entity ID of the Event animator.


Info 16x16.png Note: Entity ID cannot be edited.

Script Functions

Methods

CEventAnimatorEntity Methods
Name Parameters Return Data Type Description
Name Data Type
MixedModeCutSceneStart - void Marks that cutscene has started for mixed mode controlled entity.
Start - void Start the effect.
StartAnimation Animation IDENT void Start the given animation.
Stop - void Stop the effect.
CBaseEntity Methods
Name Parameters Return Data Type Description
Name Data Type
ApplyDamageTool
SEd3.5 or higher
DamageSource CString void To do: Add description
DamageType CString
WeaponIndex WeaponIndex
CharacterClass IDENT
Damage SLONG
EnableReceiveDamageScriptEvent
SEd3.5 or higher
- void Enables ReceiveDamage script events (see below).
Warning 16x16.png Warning: This function disables native damage handling.
EnableTouchAutoMoveTarget
SEd4.0 only
Enabled BOOL void Enables the entity to become an auto move target.
GetAngularVelocity - Vector3f Returns angular velocity of the entity in Vector3f format.
GetAttachmentAbsolutePlacement Attachment IDENT QuatVect Returns placement of attachment in relation to World Spawn in QuatVect format.
GetAttachmentRelativePlacement Attachment IDENT QuatVect Returns placement of attachment in relation to entity in QuatVect format.
GetClassName
SEd3.5 or higher
- CString Returns classname in CString format.
GetLinearVelocity - Vector3f Returns linear velocity of entity in Vector3f format.
GetName - CString Returns the name of the entity in CString format.
GetParent Name IDENT Handle Returns a CBaseEntity handle of the parent of the entity.
GetPlacement - QuatVect Returns position and orientation of the entity in QuatVect format.
GetWorld
SEd3.5 or higher
- CWorld* To do: Add description
GetWorldInfo
SEd3.5 or higher
- CWorldInfoEntity* To do: Add description
InflictDamage Amount SLONG void Inflicts damage to entity.
InflictDamageOfType Amount SLONG void Inflicts damage of a specified damage type to entity.
DamageType CString
InflictDamageToTarget
SEd3.5 or higher
Target Handle void To do: Add description
Amount SLONG
Weapon IDENT
DamageType CString
InflictWeaponDamage
SEd3.5 only
Amount SLONG void To do: Add description
Weapon IDENT
DamageType CString
IsDestroyed - BOOL Returns 1 if entity is destroyed.
IsReceiveDamageScriptEventEnabled
SEd3.5 or higher
- BOOL Returns 1 if ReceiveDamageScriptEvent is enabled (see above).
SetAngularVelocity AngVelocity Vector3f void Sets angular velocity of entity to the specified Vector3f value.
SetLinearVelocity Velocity Vector3f void Sets the velocity of the entity to the specifed Vector3f values.
SetPlacement Placement QuatVect void Sets position and orientation of the entity to the specified QuatVect values.

Events

Destroyed
Triggers when the Event animator is destroyed.
EntityDeleted → SEd3.5 or higher
Triggers when the Event animator is deleted.
ReceiveDamage → SEd3.5 or higher
Triggers when the Event animator receives damage.
Info 16x16.png Note: This event requires enabling via EnableReceiveDamageScriptEvent method.

Other Information

Event animator can be used to control Post Processing Effect, Flare, Haze, Particle Effect, Fast Light, Omni Light, Spot Light, Distant Light and so on.

Related Pages and Links