Post Processing Effect

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

General information

Class: CPostProcessingEffectEntity

A Post processing effect controls secondary image processing. When game view enters the Post processing effect range, each frame of the primary render result is re-rendered with filters and masks as specified in the Post processing effect. This can produce a variety of visual effects.

Properties

Post processing preset (CPostProcessingPreset)

Defines an entity pointer to a post processing preset which holds all render filters and their values. For more information see Post Processing Preset.


Infinite range (BOOL)

Defines if the range of the post processing effect is infinite, ie if it applies to the entire world space.


Info 16x16.png Note: Disables the following four cubic effect range properties.
Fade distance (FLOAT)

Defines a fade range in meters which is measured from the outer border of the effect range towards the effect center.


Info 16x16.png Note: Fade distance should not be higher than half the width, height, or depth of the Post processing effect range (see below) if the effect fade is supposed to work on each of these axes.
Width (FLOAT)

Defines the width of the cubic effect range.


Height (FLOAT)

Defines the height of the cubic effect range.


Depth (FLOAT)

Defines the length of the cubic effect range.


Animator (CGenericAnimator)

Defines an entity pointer to a shared animator, usually an Event Animator.


Priority override (FLOAT)
SEd4.0 only

Defines the priority of the Post processing effect for cases of overlapping Post processing effect ranges:

  • The Post processing effect with the highest priority override will be applied exclusively.
  • Equal priority overrides mean that all Post processing effects will be applied.


Parent part (IDENT)
SEd4.0 only

If the parent has more than one moving part this property defines which part the Post processing effect is parented to.


Spawn flags (LFLAGS)

Defines in which difficulty levels and game types the Post processing effect is spawned.


Name (CString)

Defines the name of the Post processing effect.


Defines a entity pointer to the parent of the Post processing effect.


Platforms (LFLAGS)

Defines on which platforms the Post processing effect is spawned.


Entity ID (ULONG)

Displays the entity ID of the Post processing effect.


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

Script Functions

Methods

Info 16x16.png Note: CPostProcessingEffectEntity does not have native 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.

Events

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

Other Information

Post processing effects are often used with Event Animators.

Related Pages and Links