Particle Effect

From Serious Sam Wiki
Revision as of 20:05, 5 May 2016 by Asdolg (Talk | contribs) (Created, Incomplete. Add more descriptions and create methods page.)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
Editor model of CParticleEffectEntity.

General information

Class: CParticleEffectEntity

The Particle effect is used to make different effects using particles. These effects can be both planar or 3D-positioned.

Properties

Effect (CEffect)

Defines an entity pointer to an effect which holds effect's settings. For more information see Effect.


Info 16x16.png Note: Editor model will not appear in the world until effect property created.

Contains base sound, which plays after effect started, and its settings.


Stretch (FLOAT)

Defines effect's stretch. This property affects particles and initial box size.


Parent part (IDENT)
SEd4.0 only

To do: Add description


Parent part attachment (IDENT)
SEd4.0 only

To do: Add description


Auto start (BOOL)

Defines if effect starts automatically after level start.


Don't classify (BOOL)

To do: Add description


Relevant entity (CBaseProperties)

To do: Add description


Controlled from script (ENUM)

Defines if the Particle effect is controlled from any type of scripting.


Custom visibility sectors (CString)

Contains all sectors, where particles shoud be rendered.


Animator (CGenericAnimator)

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


Invert animator (BOOL)

To do: Add description


Spawn flags (LFLAGS)

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


Name (CString)

Defines the name of the Particle effect.


Defines a entity pointer to the parent of the Particle effect.


Platforms (LFLAGS)

Defines on which platforms the Particle effect is spawned.


Entity ID (ULONG)

Displays the entity ID of the Particle effect.


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

Script Functions

Methods

ParticleEffect 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

Info 16x16.png Note: CParticleEffectEntity does not have native events.

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

Other Information

Particle effect can be controlled with Event Animator.

Related Pages and Links