Fog

From Serious Sam Wiki
Jump to: navigation, search
File:CFogPersp.png
Editor model of CAnimatedCameraEntity.

General information

Class: CFogEntity

Fog entity is used to make fog. Rather than Haze, Fog is visible even when camera is outside of its range.

Properties

Width (FLOAT)

Defines width of box-shaped area.


Height (FLOAT)

Defines height of box-shaped area.


Depth (FLOAT)

Defines length of box-shaped area.


Color (Color4f)

Defines color of fog.


Depth density (FLOAT)

Defines density of fog area.


Height fade length (FLOAT)

Defines how long fog will fade.


Info 16x16.png Note: Fading begins only in specified above area.
Parent part (IDENT)

To do: Add description


Visibility sectors (CString)

List of sectors in which fog entity will be visible.


Spawn flags (LFLAGS)

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


Name (CString)

Defines the name of the Fog.


Defines a entity pointer to the parent of the Fog.


Platforms (LFLAGS)

Defines on which platforms the Fog is spawned.


Entity ID (ULONG)

Displays the entity ID of the Fog.


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

Script Functions

Methods

Fog Methods

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.

Other Information

Related Pages and Links

To do: Add appropriate links.