Difference between revisions of "Aircraft Character"

From Serious Sam Wiki
Jump to: navigation, search
(Created, Incomplete. Add more descriptions, create methods page, create event templates.)
m (Events: Removed note about "native" events since we don't know if they are really native.)
Line 49: Line 49:
=== Events ===
=== Events ===
{{Note|CAircraftCharacterEntity does not have native events.}}
{{Note|Add events}}
{{Note|Add events}}
{{E_Destroyed|Aircraft character}}
{{E_Destroyed|Aircraft character}}

Latest revision as of 12:57, 7 May 2016

Editor model of CAircraftCharacterEntity.

General information

Class: CAircraftCharacterEntity

The Aircraft character entity is used to make puppet which supposed to be flying character (e.g. helicopter).


Puppet params (CPuppetParams)

Contains all main puppet settings such as moving, model, health, player controls, shooting, riding, death and so on. For more information see Puppet Params.

Info 16x16.png Note: CPuppetParams must be only CAircraftPuppetParams

Character behavior (CCharacterBehavior)

Contains all AI settings. For more information see Character Behavior.

State (IDENT)

Defines state, which entity have immediatly on spawn. States are defined in Character behaviour property.

Model override (CModelConfiguration)

Overrides model defined in Puppet params to defined here one. Used for making new aircraft with the same entity parameters file.

If created, changes entity class to spawner and should be controlled from script. For more information see Spawner.

Multi spawner template (BOOL)

To do: Add description

Threat sensivity (ENUM)

Defines puppet's sensivity, e.g. puppet can be blind (can not see players or others puppet) or deaf (can not hear them) and so on.

Instance decisions (CAIMomentHandler)

To do: Add description

Instance stretch (FLOAT)

To do: Add description

Allowed moving range (FLOAT)

Defines puppet's available moving area.

FOV instance override (FLOAT)

Overrides puppet's FOV.

Sense range override (FLOAT)

Overrides puppet's sense range, in which it can sense players.

Mounted characters (CCharacterMounts)

Contains puppets which are riding on the entity initially.

Collision with barriers (ENUM)

Defines puppet's interaction with collision barriers.

To do: Add description

Tactic marker (CPathMarkerProperties)

To do: Add description

Can attack own alignment (BOOL)

To do: Add description

Disable threat sound check (BOOL)

To do: Add description

Disable navigation usage (BOOL)

Defines if puppet will ignore navigation mesh.

Death spawner (CBaseProperties)

To do: Add description

Mounted tools (CStaticStackArray)

To do: Add description

Give up time (FLOAT)

Defines the time puppet needs to lose its foe (starts when puppet can not sense chosen foe).

Reflex min (FLOAT)

Minimum time, on which puppet will react on detected foe.

Reflex max (FLOAT)

Maximum time, on which puppet will react on detected foe.

Death item throwing (ENUM)

Possible drop from puppet, which drops on its death.

Intro marker (CPathMarkerProperties)

Defines the point, on which puppet will move initially after spawn.

Intro velocity (FLOAT)

Velocity which puppet have on spawn.

Appear animation (IDENT)

Animation which will be played immediately after puppet's spawn.

Intro animation (IDENT)

Animation which will be played immediately after appear animation.

Ignored in statistics (BOOL)

Defines if puppet will be ignored when statistics will be calculating.

Spawn flags (LFLAGS)

Defines in which difficulty levels and game types the Aircraft character is spawned.

Name (CString)

Defines the name of the Aircraft character.

Defines a entity pointer to the parent of the Aircraft character.

Platforms (LFLAGS)

Defines on which platforms the Aircraft character is spawned.

Entity ID (ULONG)

Displays the entity ID of the Aircraft character.

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

Script Functions


Info 16x16.png Note: CAircraftCharacterEntity does not have native methods. Puppet Methods

CBaseEntity Methods
Name Parameters Return Data Type Description
Name Data Type
SEd3.5 or higher
DamageSource CString void To do: Add description
DamageType CString
WeaponIndex WeaponIndex
CharacterClass IDENT
Damage SLONG
SEd3.5 or higher
- void Enables ReceiveDamage script events (see below).
Warning 16x16.png Warning: This function disables native damage handling.
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.
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.
SEd3.5 or higher
- CWorld* To do: Add description
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
SEd3.5 or higher
Target Handle void To do: Add description
Amount SLONG
Weapon IDENT
DamageType CString
SEd3.5 only
Amount SLONG void To do: Add description
Weapon IDENT
DamageType CString
IsDestroyed - BOOL Returns 1 if entity is destroyed.
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.


Info 16x16.png Note: Add events

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

Other Information

Aircraft character was only used to make helicopter in SS3:BFE.

Related Pages and Links