HPL3/Amnesia: Rebirth/Scripting/iPhysicsBody

Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!

Fields

iPhysicsBody has no public fields.

Functions

Return Type	Function And Description
void	AddChild(iEntity3D@ apEntity)
void	AddForce(const cVector3f &in avForce)
void	AddForceAtPosition(const cVector3f &in avForce, const cVector3f &in avPos)
void	AddImpulse(const cVector3f &in avImpulse)
void	AddImpulseAtPosition(const cVector3f &in avImpulse, const cVector3f &in avPos)
void	AddTorque(const cVector3f &in avTorque)
void	Enable()
void	Freeze()
float	GetAngularDamping()
cVector3f	GetAngularVelocity()
bool	GetAutoDisable()
float	GetAutoDisableAngularThreshold()
float	GetAutoDisableLinearThreshold()
int	GetAutoDisableNumSteps()
bool	GetBlocksLight()
bool	GetBlocksSound()
cBoundingVolume	GetBoundingVolume()
bool	GetBuoyancyActive()
float	GetBuoyancyAngularViscosity()
float	GetBuoyancyDensity()
float	GetBuoyancyDensityMul()
float	GetBuoyancyLinearViscosity()
cPlanef	GetBuoyancySurface()
iCharacterBody	GetCharacterBody()
cEntity3DIterator	GetChildIterator()
bool	GetCollide()
bool	GetCollideCharacter()
uint	GetCollideFlags()
bool	GetCollideRagDoll()
bool	GetContinuousCollision()
int	GetDebug_HasBeenHitCount()
bool	GetEnabled()
iEntity3D	GetEntityParent()
eEntityType	GetEntityType()
bool	GetFrozen()
bool	GetGravity()
bool	GetGravityAttachmentRotation()
bool	GetGravityAttachmentVelocity()
eVelocityAxes	GetGravityAttachmentVelocityAxes()
bool	GetGravityCanAttachCharacter()
tID	GetID()
cMatrixf	GetInertiaMatrix()
cVector3f	GetInertiaVector()
bool	GetIsUnderwater()
iPhysicsJoint	GetJoint(int alIndex)
int	GetJointNum()
float	GetLinearDamping()
cVector3f	GetLinearVelocity()
cMatrixf	GetLocalMatrix()
cVector3f	GetLocalPosition()
float	GetMass()
cVector3f	GetMassCenter()
float	GetMassMulApplied()
iPhysicsMaterial	GetMaterial()
float	GetMaxAngularSpeed()
float	GetMaxLinearSpeed()
tString	GetName()
bool	GetNoGravityWhenUnderwater()
bool	GetPushedByCharacterGravity()
int	GetPushStrength()
bool	GetScriptableIsSaved()
iCollideShape	GetShape()
bool	GetThrownByPlayer()
cVector3f	GetTorqueFromForceAtPosition(const cVector3f &in avForce, const cVector3f &in avPos)
int	GetTransformUpdateCount()
int	GetUniqueID()
bool	GetUseSurfaceEffects()
cVector3f	GetVelocityAtPosition(const cVector3f &in avPos)
cMatrixf	GetWorldMatrix()
cVector3f	GetWorldPosition()
bool	HasParent()
bool	IsActive()
bool	IsCharacter()
bool	IsChild(iEntity3D@ apEntity)
bool	IsHitboxCollectionBounds()
bool	IsHitboxCollider()
bool	IsRagDoll()
bool	IsVolatile()
void	RemoveChild(iEntity3D@ apEntity)
void	RemoveJoint(iPhysicsJoint@ apJoint)
void	RenderDebugGeometry(iLowLevelGraphics@ apLowLevel, const cColor &in aColor)
void	SetActive(bool abActive)
void	SetAngularDamping(float afDamping)
void	SetAngularVelocity(const cVector3f &in avVel)
void	SetAutoDisable(bool abEnabled)
void	SetAutoDisableAngularThreshold(float afThresold)
void	SetAutoDisableLinearThreshold(float afThresold)
void	SetAutoDisableNumSteps(int alNum)
void	SetBlocksLight(bool abX)
void	SetBlocksSound(bool abX)
void	SetBuoyancyActive(bool abX)
void	SetBuoyancyAngularViscosity(float afX)
void	SetBuoyancyDensity(float afX)
void	SetBuoyancyDensityMul(float afX)
void	SetBuoyancyLinearViscosity(float afX)
void	SetBuoyancySurface(const cPlanef &in aP)
void	SetCollide(bool abX)
void	SetCollideCharacter(bool abX)
void	SetCollideFlags(uint alX)
void	SetCollideRagDoll(bool abX)
void	SetContinuousCollision(bool abOn)
void	SetDebug_HasBeenHitCount(int alX)
void	SetGravity(bool abEnabled)
void	SetGravityAttachmentRotation(bool abX)
void	SetGravityAttachmentVelocity(bool abX)
void	SetGravityAttachmentVelocityAxes(eVelocityAxes aAxes)
void	SetGravityCanAttachCharacter(bool abX)
void	SetHitboxCollectionBounds(bool abX)
void	SetHitboxCollider(bool abX)
void	SetIsUnderwater(bool abX)
void	SetLinearDamping(float afDamping)
void	SetLinearVelocity(const cVector3f &in avVel)
void	SetMass(float afMass)
void	SetMassCenter(const cVector3f &in avCentre)
void	SetMassMulApplied(float afMul)
void	SetMaterial(iPhysicsMaterial@ aMat)
void	SetMatrix(const cMatrixf &in a_mtxTransform)
void	SetMaxAngularSpeed(float afDamping)
void	SetMaxLinearSpeed(float afSpeed)
void	SetName(const tString &in asName)
void	SetNoGravityWhenUnderwater(bool abX)
void	SetPosition(const cVector3f &in avPos)
void	SetPushedByCharacterGravity(bool abX)
void	SetPushStrength(int alX)
void	SetScriptableIsSaved(bool abX)
void	SetThrownByPlayer(bool abX)
void	SetUseSurfaceEffects(bool abX)
void	SetVolatile(bool abX)
void	SetWorldMatrix(const cMatrixf &in a_mtxWorldTransform)
void	SetWorldPosition(const cVector3f &in avWorldPos)
void	StaticAngularMove(const cVector3f &in avVelocity)
void	StaticLinearMove(const cVector3f &in avVelocity)
void	StopRollSound()
void	StopScrapeSound()
void	UpdateLogic(float afTimeStep)

Details

AddChild

void AddChild(iEntity3D@ apEntity)

Parameters

• apEntity (iEntity3D@) —

Returns:

• void

AddForce

void AddForce(const cVector3f &in avForce)

Parameters

• avForce (cVector3f) —

Returns:

• void

AddForceAtPosition

void AddForceAtPosition(const cVector3f &in avForce,
                        const cVector3f &in avPos)

Parameters

• avForce (cVector3f) —
• avPos (cVector3f) —

Returns:

• void

AddImpulse

void AddImpulse(const cVector3f &in avImpulse)

Parameters

• avImpulse (cVector3f) —

Returns:

• void

AddImpulseAtPosition

void AddImpulseAtPosition(const cVector3f &in avImpulse,
                          const cVector3f &in avPos)

Parameters

• avImpulse (cVector3f) —
• avPos (cVector3f) —

Returns:

• void

AddTorque

void AddTorque(const cVector3f &in avTorque)

Parameters

• avTorque (cVector3f) —

Returns:

• void

Enable

void Enable()

Returns:

• void

Freeze

void Freeze()

Returns:

• void

GetAngularDamping

float GetAngularDamping()

Returns:

• float—

GetAngularVelocity

cVector3f GetAngularVelocity()

Returns:

• cVector3f—

GetAutoDisable

bool GetAutoDisable()

Returns:

• bool—

GetAutoDisableAngularThreshold

float GetAutoDisableAngularThreshold()

Returns:

• float—

GetAutoDisableLinearThreshold

float GetAutoDisableLinearThreshold()

Returns:

• float—

GetAutoDisableNumSteps

int GetAutoDisableNumSteps()

Returns:

• int—

GetBlocksLight

bool GetBlocksLight()

Returns:

• bool—

GetBlocksSound

bool GetBlocksSound()

Returns:

• bool—

GetBoundingVolume

cBoundingVolume@+ GetBoundingVolume()

Returns:

• cBoundingVolume@+—

GetBuoyancyActive

bool GetBuoyancyActive()

Returns:

• bool—

GetBuoyancyAngularViscosity

float GetBuoyancyAngularViscosity()

Returns:

• float—

GetBuoyancyDensity

float GetBuoyancyDensity()

Returns:

• float—

GetBuoyancyDensityMul

float GetBuoyancyDensityMul()

Returns:

• float—

GetBuoyancyLinearViscosity

float GetBuoyancyLinearViscosity()

Returns:

• float—

GetBuoyancySurface

cPlanef GetBuoyancySurface()

Returns:

• cPlanef—

GetCharacterBody

iCharacterBody@ GetCharacterBody()

Returns:

• iCharacterBody@—

GetChildIterator

cEntity3DIterator@ GetChildIterator()

Returns:

• cEntity3DIterator@—

GetCollide

bool GetCollide()

Returns:

• bool—

GetCollideCharacter

bool GetCollideCharacter()

Returns:

• bool—

GetCollideFlags

uint GetCollideFlags()

Returns:

• uint—

GetCollideRagDoll

bool GetCollideRagDoll()

Returns:

• bool—

GetContinuousCollision

bool GetContinuousCollision()

Returns:

• bool—

GetDebug_HasBeenHitCount

int GetDebug_HasBeenHitCount()

Returns:

• int—

GetEnabled

bool GetEnabled()

Returns:

• bool—

GetEntityParent

iEntity3D@ GetEntityParent()

Returns:

• iEntity3D@—

GetEntityType

eEntityType GetEntityType()

Returns:

• eEntityType—

GetFrozen

bool GetFrozen()

Returns:

• bool—

GetGravity

bool GetGravity()

Returns:

• bool—

GetGravityAttachmentRotation

bool GetGravityAttachmentRotation()

Returns:

• bool—

GetGravityAttachmentVelocity

bool GetGravityAttachmentVelocity()

Returns:

• bool—

GetGravityAttachmentVelocityAxes

eVelocityAxes GetGravityAttachmentVelocityAxes()

Returns:

• eVelocityAxes—

GetGravityCanAttachCharacter

bool GetGravityCanAttachCharacter()

Returns:

• bool—

GetID

tID GetID()

Returns:

• tID—

GetInertiaMatrix

cMatrixf GetInertiaMatrix()

Returns:

• cMatrixf—

GetInertiaVector

cVector3f GetInertiaVector()

Returns:

• cVector3f—

GetIsUnderwater

bool GetIsUnderwater()

Returns:

• bool—

GetJoint

iPhysicsJoint@ GetJoint(int alIndex)

Parameters

• alIndex (int) —

Returns:

• iPhysicsJoint@—

GetJointNum

int GetJointNum()

Returns:

• int—

GetLinearDamping

float GetLinearDamping()

Returns:

• float—

GetLinearVelocity

cVector3f GetLinearVelocity()

Returns:

• cVector3f—

GetLocalMatrix

cMatrixf& GetLocalMatrix()

Returns:

• cMatrixf&—

GetLocalPosition

cVector3f GetLocalPosition()

Returns:

• cVector3f—

GetMass

float GetMass()

Returns:

• float—

GetMassCenter

cVector3f GetMassCenter()

Returns:

• cVector3f—

GetMassMulApplied

float GetMassMulApplied()

Returns:

• float—

GetMaterial

iPhysicsMaterial@ GetMaterial()

Returns:

• iPhysicsMaterial@—

GetMaxAngularSpeed

float GetMaxAngularSpeed()

Returns:

• float—

GetMaxLinearSpeed

float GetMaxLinearSpeed()

Returns:

• float—

GetName

const tString& GetName()

Returns:

• const tString&—

GetNoGravityWhenUnderwater

bool GetNoGravityWhenUnderwater()

Returns:

• bool—

GetPushedByCharacterGravity

bool GetPushedByCharacterGravity()

Returns:

• bool—

GetPushStrength

int GetPushStrength()

Returns:

• int—

GetScriptableIsSaved

bool GetScriptableIsSaved()

Returns:

• bool—

GetShape

iCollideShape@ GetShape()

Returns:

• iCollideShape@—

GetThrownByPlayer

bool GetThrownByPlayer()

Returns:

• bool—

GetTorqueFromForceAtPosition

cVector3f GetTorqueFromForceAtPosition(const cVector3f &in avForce,
                                       const cVector3f &in avPos)

Parameters

• avForce (cVector3f) —
• avPos (cVector3f) —

Returns:

• cVector3f—

GetTransformUpdateCount

int GetTransformUpdateCount()

Returns:

• int—

GetUniqueID

int GetUniqueID()

Returns:

• int—

GetUseSurfaceEffects

bool GetUseSurfaceEffects()

Returns:

• bool—

GetVelocityAtPosition

cVector3f GetVelocityAtPosition(const cVector3f &in avPos)

Parameters

• avPos (cVector3f) —

Returns:

• cVector3f—

GetWorldMatrix

cMatrixf& GetWorldMatrix()

Returns:

• cMatrixf&—

GetWorldPosition

cVector3f GetWorldPosition()

Returns:

• cVector3f—

HasParent

bool HasParent()

Returns:

• bool—

IsActive

bool IsActive()

Returns:

• bool—

IsCharacter

bool IsCharacter()

Returns:

• bool—

IsChild

bool IsChild(iEntity3D@ apEntity)

Parameters

• apEntity (iEntity3D@) —

Returns:

• bool—

IsHitboxCollectionBounds

bool IsHitboxCollectionBounds()

Returns:

• bool—

IsHitboxCollider

bool IsHitboxCollider()

Returns:

• bool—

IsRagDoll

bool IsRagDoll()

Returns:

• bool—

IsVolatile

bool IsVolatile()

Returns:

• bool—

RemoveChild

void RemoveChild(iEntity3D@ apEntity)

Parameters

• apEntity (iEntity3D@) —

Returns:

• void

RemoveJoint

void RemoveJoint(iPhysicsJoint@ apJoint)

Parameters

• apJoint (iPhysicsJoint@) —

Returns:

• void

RenderDebugGeometry

void RenderDebugGeometry(iLowLevelGraphics@ apLowLevel,
                         const cColor &in aColor)

Parameters

• apLowLevel (iLowLevelGraphics@) —
• aColor (cColor) —

Returns:

• void

SetActive

void SetActive(bool abActive)

Parameters

• abActive (bool) —

Returns:

• void

SetAngularDamping

void SetAngularDamping(float afDamping)

Parameters

• afDamping (float) —

Returns:

• void

SetAngularVelocity

void SetAngularVelocity(const cVector3f &in avVel)

Parameters

• avVel (cVector3f) —

Returns:

• void

SetAutoDisable

void SetAutoDisable(bool abEnabled)

Parameters

• abEnabled (bool) —

Returns:

• void

SetAutoDisableAngularThreshold

void SetAutoDisableAngularThreshold(float afThresold)

Parameters

• afThresold (float) —

Returns:

• void

SetAutoDisableLinearThreshold

void SetAutoDisableLinearThreshold(float afThresold)

Parameters

• afThresold (float) —

Returns:

• void

SetAutoDisableNumSteps

void SetAutoDisableNumSteps(int alNum)

Parameters

• alNum (int) —

Returns:

• void

SetBlocksLight

void SetBlocksLight(bool abX)

Parameters

• abX (bool) —

Returns:

• void

SetBlocksSound

void SetBlocksSound(bool abX)

Parameters

• abX (bool) —

Returns:

• void

SetBuoyancyActive

void SetBuoyancyActive(bool abX)

Parameters

• abX (bool) —

Returns:

• void

SetBuoyancyAngularViscosity

void SetBuoyancyAngularViscosity(float afX)

Parameters

• afX (float) —

Returns:

• void

SetBuoyancyDensity

void SetBuoyancyDensity(float afX)

Parameters

• afX (float) —

Returns:

• void

SetBuoyancyDensityMul

void SetBuoyancyDensityMul(float afX)

Parameters

• afX (float) —

Returns:

• void

SetBuoyancyLinearViscosity

void SetBuoyancyLinearViscosity(float afX)

Parameters

• afX (float) —

Returns:

• void

SetBuoyancySurface

void SetBuoyancySurface(const cPlanef &in aP)

Parameters

• aP (cPlanef) —

Returns:

• void

SetCollide

void SetCollide(bool abX)

Parameters

• abX (bool) —

Returns:

• void

SetCollideCharacter

void SetCollideCharacter(bool abX)

Parameters

• abX (bool) —

Returns:

• void

SetCollideFlags

void SetCollideFlags(uint alX)

Parameters

• alX (uint) —

Returns:

• void

SetCollideRagDoll

void SetCollideRagDoll(bool abX)

Parameters

• abX (bool) —

Returns:

• void

SetContinuousCollision

void SetContinuousCollision(bool abOn)

Parameters

• abOn (bool) —

Returns:

• void

SetDebug_HasBeenHitCount

void SetDebug_HasBeenHitCount(int alX)

Parameters

• alX (int) —

Returns:

• void

SetGravity

void SetGravity(bool abEnabled)

Parameters

• abEnabled (bool) —

Returns:

• void

SetGravityAttachmentRotation

void SetGravityAttachmentRotation(bool abX)

Parameters

• abX (bool) —

Returns:

• void

SetGravityAttachmentVelocity

void SetGravityAttachmentVelocity(bool abX)

Parameters

• abX (bool) —

Returns:

• void

SetGravityAttachmentVelocityAxes

void SetGravityAttachmentVelocityAxes(eVelocityAxes aAxes)

Parameters

• aAxes (eVelocityAxes) —

Returns:

• void

SetGravityCanAttachCharacter

void SetGravityCanAttachCharacter(bool abX)

Parameters

• abX (bool) —

Returns:

• void

SetHitboxCollectionBounds

void SetHitboxCollectionBounds(bool abX)

Parameters

• abX (bool) —

Returns:

• void

SetHitboxCollider

void SetHitboxCollider(bool abX)

Parameters

• abX (bool) —

Returns:

• void

SetIsUnderwater

void SetIsUnderwater(bool abX)

Parameters

• abX (bool) —

Returns:

• void

SetLinearDamping

void SetLinearDamping(float afDamping)

Parameters

• afDamping (float) —

Returns:

• void

SetLinearVelocity

void SetLinearVelocity(const cVector3f &in avVel)

Parameters

• avVel (cVector3f) —

Returns:

• void

SetMass

void SetMass(float afMass)

Parameters

• afMass (float) —

Returns:

• void

SetMassCenter

void SetMassCenter(const cVector3f &in avCentre)

Parameters

• avCentre (cVector3f) —

Returns:

• void

SetMassMulApplied

void SetMassMulApplied(float afMul)

Parameters

• afMul (float) —

Returns:

• void

SetMaterial

void SetMaterial(iPhysicsMaterial@ aMat)

Parameters

• aMat (iPhysicsMaterial@) —

Returns:

• void

SetMatrix

void SetMatrix(const cMatrixf &in a_mtxTransform)

Parameters

• a_mtxTransform (cMatrixf) —

Returns:

• void

SetMaxAngularSpeed

void SetMaxAngularSpeed(float afDamping)

Parameters

• afDamping (float) —

Returns:

• void

SetMaxLinearSpeed

void SetMaxLinearSpeed(float afSpeed)

Parameters

• afSpeed (float) —

Returns:

• void

SetName

void SetName(const tString &in asName)

Parameters

• asName (tString) —

Returns:

• void

SetNoGravityWhenUnderwater

void SetNoGravityWhenUnderwater(bool abX)

Parameters

• abX (bool) —

Returns:

• void

SetPosition

void SetPosition(const cVector3f &in avPos)

Parameters

• avPos (cVector3f) —

Returns:

• void

SetPushedByCharacterGravity

void SetPushedByCharacterGravity(bool abX)

Parameters

• abX (bool) —

Returns:

• void

SetPushStrength

void SetPushStrength(int alX)

Parameters

• alX (int) —

Returns:

• void

SetScriptableIsSaved

void SetScriptableIsSaved(bool abX)

Parameters

• abX (bool) —

Returns:

• void

SetThrownByPlayer

void SetThrownByPlayer(bool abX)

Parameters

• abX (bool) —

Returns:

• void

SetUseSurfaceEffects

void SetUseSurfaceEffects(bool abX)

Parameters

• abX (bool) —

Returns:

• void

SetVolatile

void SetVolatile(bool abX)

Parameters

• abX (bool) —

Returns:

• void

SetWorldMatrix

void SetWorldMatrix(const cMatrixf &in a_mtxWorldTransform)

Parameters

• a_mtxWorldTransform (cMatrixf) —

Returns:

• void

SetWorldPosition

void SetWorldPosition(const cVector3f &in avWorldPos)

Parameters

• avWorldPos (cVector3f) —

Returns:

• void

StaticAngularMove

void StaticAngularMove(const cVector3f &in avVelocity)

Parameters

• avVelocity (cVector3f) —

Returns:

• void

StaticLinearMove

void StaticLinearMove(const cVector3f &in avVelocity)

Parameters

• avVelocity (cVector3f) —

Returns:

• void

StopRollSound

void StopRollSound()

Returns:

• void

StopScrapeSound

void StopScrapeSound()

Returns:

• void

UpdateLogic

void UpdateLogic(float afTimeStep)

Parameters

• afTimeStep (float) —

Returns:

• void

References

• HPL3/Amnesia: Rebirth/Scripting/Scripting Api ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/cBoneState ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/cLuxAgent ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/cLuxArea ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/cLuxClosestCharCollider ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/cLuxClosestEntityData ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/cLuxCritter ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/cLuxLiquidArea ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/cLuxPlayer ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/cLuxProp ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/cLuxPushableFogArea ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/cLuxSoundscapeArea ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/cLuxVisibilityPortal ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/iCharacterBody ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/iLuxEntity ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/iPhysicsCloth ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/iPhysicsJoint ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/iPhysicsJointBall ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/iPhysicsJointHinge ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/iPhysicsJointSlider ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/iPhysicsRope ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/iPhysicsWorld ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/iScrMoveState Interface ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/iScrPlayer Interface ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/iScrPlayerState Interface ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/iVerletParticleContainer ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/Scripting Api/cLux ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/Scripting Api/cPhysics ‎ (← links)

See all references...