Background Viewer

From Serious Sam Wiki
Revision as of 12:57, 7 May 2016 by Asdolg (Talk | contribs) (Events: Removed note about "native" events since we don't know if they are really native.)

Jump to: navigation, search
Editor model of CBackgroundViewerEntity.

General information

Class: CBackgroundViewerEntity

The Background viewer is an entity used to set the custom point from which background is seen.

Properties

Active (BOOL)

Defines if the entity is used by default.


Active range (Box3f)

Defines an area in which entity should work.


Spawn flags (LFLAGS)

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


Name (CString)

Defines the name of the Background viewer.


Defines a entity pointer to the parent of the Background viewer.


Platforms (LFLAGS)

Defines on which platforms the Background viewer is spawned.


Entity ID (ULONG)

Displays the entity ID of the Background viewer.


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

Script Functions

Methods

CBackgroundViewerEntity Methods
Name Parameters Return Data Type Description
Name Data Type
Activate - void Activates the entity so it would work.
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 Static model is destroyed.
EntityDeleted → SEd3.5 or higher
Triggers when the Static model is deleted.
ReceiveDamage → SEd3.5 or higher
Triggers when the Static model receives damage.
Info 16x16.png Note: This event requires enabling via EnableReceiveDamageScriptEvent method.

Other Information

  • You should place the entity into Cube Background to see an effect.
  • You can not have both background viewer and cube background activated on the same time. When one of them activates, the second shuts down, since each of them uses its own view point.


Related Pages and Links