List of Entity Methods

From Serious Sam Wiki
Revision as of 00:45, 2 May 2016 by Innocentive (Talk | contribs) (creation)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

This is a list of methods per class in alphabetical order of class:

CAnimatedCameraEntity Methods
Name Parameters Return Data Type Description
Name Data Type
AddAnimation
SEd4.0 only
AnimName IDENT void Adds an animation to the Camera.
DisableUserBreak - void Disables the the user to stop a Camera animation cutscene.
EnableUserBreak - void Enables the user to stop a Camera animation cutscene.
GetAnimationLength AnimName IDENT FLOAT Returns length of given anmimation in FLOAT format.
GetDefaultFOV
SEd4.0 only
- FLOAT Returns the default FOV setting in degrees.
GetDefaultPlacement - QuatVect Returns default position and orientation of the Camera in QuatVect format.
LastAnimationWasInterrupted - BOOL Returns 1 if the last Camera animation was interrupted.
PlayAnimWait AnimName IDENT LatentFuncID Starts Camera with specified animation and waits until animation is finished.
SetCurrent - void Sets current Camera.
SetDefaultPlacement Default QuatVect void Sets default position and orientation of the Camera to the specied QuatVect values.
StartWait AutoStopTime FLOAT void Activates the Camera and stops it after specified amount of seconds.
Stop - void Stops the camera.
CCameraEntity Methods
Name Parameters Return Data Type Description
Name Data Type
GetTanFOV - FLOAT Returns tangent of the half of FOV angle which is really used by the camera when setting up the projection matrix.
MouseHitTest *pas IArgumentStack void Performs a raycast from current screen space coordinates into the scene and retrieves hit entity, hull, and position. For more information see Mouse Hit Test.
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.