HPL3/Amnesia: Rebirth/Scripting/iPhysicsWorld

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

Fields

iPhysicsWorld has no public fields.

Functions

Return Type	Function And Description
float	CastRayOnShape(iCollideShape@ apShape, const cMatrixf &in a_mtxTransform, const cVector3f &in avOrigin, const cVector3f &in avEnd, cVector3f &out avOutNormal, bool abLocalRayPositions)
bool	CheckShapeCollision(iCollideShape@ apShapeA, const cMatrixf &in a_mtxA, iCollideShape@ apShapeB, const cMatrixf &in a_mtxB, cCollideData &inout aCollideData, int alMaxPoints, bool abCorrectNormalDirection, int alThreadID = 0)
bool	CheckShapeWorldCollision(cVector3f &out avPushVector, iCollideShape@ apShape, const cMatrixf &in a_mtxTransform, iPhysicsBody@ apSkipBody, bool abSkipStatic, bool abIsCharacter, bool abCollideCharacter)
bool	CheckShapeWorldCollision(cVector3f &out avPushVector, iCollideShape@ apShape, const cMatrixf &in a_mtxTransform, iPhysicsBody@ apSkipBody, bool abSkipStatic)
iPhysicsBody	CreateBody(const tString &in asName, iCollideShape@ apShape, float afMass)
tID	CreateBodyID(const tString &in asName, iCollideShape@ apShape, float afMass)
iCollideShape	CreateBoxShape(const cVector3f &in avSize, cMatrixf &in a_mtxOffsetMtx)
iCollideShape	CreateCapsuleShape(float afRadius, float afHeight, cMatrixf &in a_mtxOffsetMtx)
iCharacterBody	CreateCharacterBody(const tString &in asName, const cVector3f &in avSize)
tID	CreateCharacterBodyID(const tString &in asName, const cVector3f &in avSize)
iPhysicsCloth	CreateCloth(const tString &in asName, const cVector3f &in avStartPos, const cVector2f &in avClothSize, int alDimension)
iCollideShape	CreateCompundShape(array<iCollideShape@> avShapes)
iPhysicsController	CreateController(const tString &in asName)
iCollideShape	CreateCylinderShape(float afRadius, float afHeight, cMatrixf &in a_mtxOffsetMtx)
iPhysicsJointBall	CreateJointBall(const tString &in asName, const cVector3f &in avPivotPoint, const cVector3f &in avPinDir, iPhysicsBody@ apParentBody, iPhysicsBody@ apChildBody)
tID	CreateJointBallID(const tString &in asName, const cVector3f &in avPivotPoint, const cVector3f &in avPinDir, iPhysicsBody@ apParentBody, iPhysicsBody@ apChildBody)
iPhysicsJointHinge	CreateJointHinge(const tString &in asName, const cVector3f &in avPivotPoint, const cVector3f &in avPinDir, iPhysicsBody@ apParentBody, iPhysicsBody@ apChildBody)
tID	CreateJointHingeID(const tString &in asName, const cVector3f &in avPivotPoint, const cVector3f &in avPinDir, iPhysicsBody@ apParentBody, iPhysicsBody@ apChildBody)
iPhysicsJointSlider	CreateJointSlider(const tString &in asName, const cVector3f &in avPivotPoint, const cVector3f &in avPinDir, iPhysicsBody@ apParentBody, iPhysicsBody@ apChildBody)
tID	CreateJointSliderID(const tString &in asName, const cVector3f &in avPivotPoint, const cVector3f &in avPinDir, iPhysicsBody@ apParentBody, iPhysicsBody@ apChildBody)
iPhysicsMaterial	CreateMaterial(const tString &in asName)
iCollideShape	CreateMeshShape(iVertexBuffer@ apVtxBuffer)
iPhysicsRope	CreateRope(const tString &in asName, const cVector3f &in avStartPos, const cVector3f &in avEndPos)
iCollideShape	CreateSphereShape(const cVector3f &in avRadii, cMatrixf &in a_mtxOffsetMtx)
void	DestroyBody(iPhysicsBody@ apBody)
void	DestroyCharacterBody(iCharacterBody@ apBody)
void	DestroyCloth(iPhysicsCloth@ apCloth)
void	DestroyController(iPhysicsController@ apController)
void	DestroyJoint(iPhysicsJoint@ apJoint)
void	DestroyRope(iPhysicsRope@ apRope)
void	DestroyShape(iCollideShape@ apShape)
void	EnableBodiesInAABB(const cVector3f &in avMin, const cVector3f &in avMax, bool abEnabled)
void	FadeoutAllLoopSounds(float afFadeSpeed)
ePhysicsAccuracy	GetAccuracyLevel()
void	GetBodiesInAABB(const cVector3f &in avMin, const cVector3f &in avMax, array<iPhysicsBody@> apBodyVec)
iPhysicsBody	GetBody(const tString &in asName)
iPhysicsBody	GetCharacterBody(const tString &in asName)
iCharacterBody	GetCharacterBodyFromID(tID aID)
iPhysicsCloth	GetCloth(const tString &in asName)
iPhysicsCloth	GetClothFromUniqueID(int alID)
cVector3f	GetGravity()
iPhysicsJoint	GetJoint(const tString &in asName)
iPhysicsMaterial	GetMaterialFromId(int alId)
iPhysicsMaterial	GetMaterialFromName(const tString &in asName)
float	GetMaxTimeStep()
int	GetNumberOfThreads()
iPhysicsBody	GetPhysicsBodyFromID(tID aID)
iPhysicsJoint	GetPhysicsJointFromID(tID aID)
iPhysicsRope	GetRope(const tString &in asName)
iPhysicsRope	GetRopeFromUniqueID(int alID)
cVector3f	GetWorldSizeMax()
cVector3f	GetWorldSizeMin()
bool	JointExists(iPhysicsJoint@ apJoint)
iCollideShape	LoadMeshShapeFromBuffer(cBinaryBuffer@ apBuffer)
void	PostUpdate(float afTimeStep)
void	RenderDebugGeometry(iLowLevelGraphics@ apLowLevel)
void	RenderShapeDebugGeometry(iCollideShape@ apShape, const cMatrixf &in a_mtxTransform, iLowLevelGraphics@ apLowLevel, const cColor &in aColor)
void	SaveMeshShapeToBuffer(iCollideShape@ apMeshShape, cBinaryBuffer@ apBuffer)
void	SetAccuracyLevel(ePhysicsAccuracy aAccuracy)
void	SetGravity(const cVector3f &in avGravity)
void	SetMaxTimeStep(float afTimeStep)
void	SetNumberOfThreads(int alThreads)
void	SetWorldSize(const cVector3f &in avMin, const cVector3f &in avMax)

Details

CastRayOnShape

float CastRayOnShape(iCollideShape@ apShape,
                     const cMatrixf &in a_mtxTransform,
                     const cVector3f &in avOrigin,
                     const cVector3f &in avEnd,
                     cVector3f &out avOutNormal,
                     bool abLocalRayPositions)

Parameters

• apShape (iCollideShape@) —
• a_mtxTransform (cMatrixf) —
• avOrigin (cVector3f) —
• avEnd (cVector3f) —
• avOutNormal (cVector3f) —
• abLocalRayPositions (bool) —

Returns:

• float—

CheckShapeCollision

bool CheckShapeCollision(iCollideShape@ apShapeA,
                         const cMatrixf &in a_mtxA,
                         iCollideShape@ apShapeB,
                         const cMatrixf &in a_mtxB,
                         cCollideData &inout aCollideData,
                         int alMaxPoints,
                         bool abCorrectNormalDirection,
                         int alThreadID = 0)

Parameters

• apShapeA (iCollideShape@) —
• a_mtxA (cMatrixf) —
• apShapeB (iCollideShape@) —
• a_mtxB (cMatrixf) —
• aCollideData (cCollideData) —
• alMaxPoints (int) —
• abCorrectNormalDirection (bool) —
• alThreadID (int) —

Returns:

• bool—

CheckShapeWorldCollision

bool CheckShapeWorldCollision(cVector3f &out avPushVector,
                              iCollideShape@ apShape,
                              const cMatrixf &in a_mtxTransform,
                              iPhysicsBody@ apSkipBody,
                              bool abSkipStatic,
                              bool abIsCharacter,
                              bool abCollideCharacter)

Parameters

• avPushVector (cVector3f) —
• apShape (iCollideShape@) —
• a_mtxTransform (cMatrixf) —
• apSkipBody (iPhysicsBody@) —
• abSkipStatic (bool) —
• abIsCharacter (bool) —
• abCollideCharacter (bool) —

Returns:

• bool—

CheckShapeWorldCollision

bool CheckShapeWorldCollision(cVector3f &out avPushVector,
                              iCollideShape@ apShape,
                              const cMatrixf &in a_mtxTransform,
                              iPhysicsBody@ apSkipBody,
                              bool abSkipStatic)

Parameters

• avPushVector (cVector3f) —
• apShape (iCollideShape@) —
• a_mtxTransform (cMatrixf) —
• apSkipBody (iPhysicsBody@) —
• abSkipStatic (bool) —

Returns:

• bool—

CreateBody

iPhysicsBody@ CreateBody(const tString &in asName,
                         iCollideShape@ apShape,
                         float afMass)

Parameters

• asName (tString) —
• apShape (iCollideShape@) —
• afMass (float) —

Returns:

• iPhysicsBody@—

CreateBodyID

tID CreateBodyID(const tString &in asName,
                 iCollideShape@ apShape,
                 float afMass)

Parameters

• asName (tString) —
• apShape (iCollideShape@) —
• afMass (float) —

Returns:

• tID—

CreateBoxShape

iCollideShape@ CreateBoxShape(const cVector3f &in avSize,
                              cMatrixf &in a_mtxOffsetMtx)

Parameters

• avSize (cVector3f) —
• a_mtxOffsetMtx (cMatrixf) —

Returns:

• iCollideShape@—

CreateCapsuleShape

iCollideShape@ CreateCapsuleShape(float afRadius,
                                  float afHeight,
                                  cMatrixf &in a_mtxOffsetMtx)

Parameters

• afRadius (float) —
• afHeight (float) —
• a_mtxOffsetMtx (cMatrixf) —

Returns:

• iCollideShape@—

CreateCharacterBody

iCharacterBody@ CreateCharacterBody(const tString &in asName,
                                    const cVector3f &in avSize)

Parameters

• asName (tString) —
• avSize (cVector3f) —

Returns:

• iCharacterBody@—

CreateCharacterBodyID

tID CreateCharacterBodyID(const tString &in asName,
                          const cVector3f &in avSize)

Parameters

• asName (tString) —
• avSize (cVector3f) —

Returns:

• tID—

CreateCloth

iPhysicsCloth@ CreateCloth(const tString &in asName,
                           const cVector3f &in avStartPos,
                           const cVector2f &in avClothSize,
                           int alDimension)

Parameters

• asName (tString) —
• avStartPos (cVector3f) —
• avClothSize (cVector2f) —
• alDimension (int) —

Returns:

• iPhysicsCloth@—

CreateCompundShape

iCollideShape@ CreateCompundShape(iCollideShape@ avShapes)

Parameters

• avShapes (iCollideShape@) —

Returns:

• iCollideShape@—

CreateController

iPhysicsController@ CreateController(const tString &in asName)

Parameters

• asName (tString) —

Returns:

• iPhysicsController@—

CreateCylinderShape

iCollideShape@ CreateCylinderShape(float afRadius,
                                   float afHeight,
                                   cMatrixf &in a_mtxOffsetMtx)

Parameters

• afRadius (float) —
• afHeight (float) —
• a_mtxOffsetMtx (cMatrixf) —

Returns:

• iCollideShape@—

CreateJointBall

iPhysicsJointBall@ CreateJointBall(const tString &in asName,
                                   const cVector3f &in avPivotPoint,
                                   const cVector3f &in avPinDir,
                                   iPhysicsBody@ apParentBody,
                                   iPhysicsBody@ apChildBody)

Parameters

• asName (tString) —
• avPivotPoint (cVector3f) —
• avPinDir (cVector3f) —
• apParentBody (iPhysicsBody@) —
• apChildBody (iPhysicsBody@) —

Returns:

• iPhysicsJointBall@—

CreateJointBallID

tID CreateJointBallID(const tString &in asName,
                      const cVector3f &in avPivotPoint,
                      const cVector3f &in avPinDir,
                      iPhysicsBody@ apParentBody,
                      iPhysicsBody@ apChildBody)

Parameters

• asName (tString) —
• avPivotPoint (cVector3f) —
• avPinDir (cVector3f) —
• apParentBody (iPhysicsBody@) —
• apChildBody (iPhysicsBody@) —

Returns:

• tID—

CreateJointHinge

iPhysicsJointHinge@ CreateJointHinge(const tString &in asName,
                                     const cVector3f &in avPivotPoint,
                                     const cVector3f &in avPinDir,
                                     iPhysicsBody@ apParentBody,
                                     iPhysicsBody@ apChildBody)

Parameters

• asName (tString) —
• avPivotPoint (cVector3f) —
• avPinDir (cVector3f) —
• apParentBody (iPhysicsBody@) —
• apChildBody (iPhysicsBody@) —

Returns:

• iPhysicsJointHinge@—

CreateJointHingeID

tID CreateJointHingeID(const tString &in asName,
                       const cVector3f &in avPivotPoint,
                       const cVector3f &in avPinDir,
                       iPhysicsBody@ apParentBody,
                       iPhysicsBody@ apChildBody)

Parameters

• asName (tString) —
• avPivotPoint (cVector3f) —
• avPinDir (cVector3f) —
• apParentBody (iPhysicsBody@) —
• apChildBody (iPhysicsBody@) —

Returns:

• tID—

CreateJointSlider

iPhysicsJointSlider@ CreateJointSlider(const tString &in asName,
                                       const cVector3f &in avPivotPoint,
                                       const cVector3f &in avPinDir,
                                       iPhysicsBody@ apParentBody,
                                       iPhysicsBody@ apChildBody)

Parameters

• asName (tString) —
• avPivotPoint (cVector3f) —
• avPinDir (cVector3f) —
• apParentBody (iPhysicsBody@) —
• apChildBody (iPhysicsBody@) —

Returns:

• iPhysicsJointSlider@—

CreateJointSliderID

tID CreateJointSliderID(const tString &in asName,
                        const cVector3f &in avPivotPoint,
                        const cVector3f &in avPinDir,
                        iPhysicsBody@ apParentBody,
                        iPhysicsBody@ apChildBody)

Parameters

• asName (tString) —
• avPivotPoint (cVector3f) —
• avPinDir (cVector3f) —
• apParentBody (iPhysicsBody@) —
• apChildBody (iPhysicsBody@) —

Returns:

• tID—

CreateMaterial

iPhysicsMaterial@ CreateMaterial(const tString &in asName)

Parameters

• asName (tString) —

Returns:

• iPhysicsMaterial@—

CreateMeshShape

iCollideShape@ CreateMeshShape(iVertexBuffer@ apVtxBuffer)

Parameters

• apVtxBuffer (iVertexBuffer@) —

Returns:

• iCollideShape@—

CreateRope

iPhysicsRope@ CreateRope(const tString &in asName,
                         const cVector3f &in avStartPos,
                         const cVector3f &in avEndPos)

Parameters

• asName (tString) —
• avStartPos (cVector3f) —
• avEndPos (cVector3f) —

Returns:

• iPhysicsRope@—

CreateSphereShape

iCollideShape@ CreateSphereShape(const cVector3f &in avRadii,
                                 cMatrixf &in a_mtxOffsetMtx)

Parameters

• avRadii (cVector3f) —
• a_mtxOffsetMtx (cMatrixf) —

Returns:

• iCollideShape@—

DestroyBody

void DestroyBody(iPhysicsBody@ apBody)

Parameters

• apBody (iPhysicsBody@) —

Returns:

• void

DestroyCharacterBody

void DestroyCharacterBody(iCharacterBody@ apBody)

Parameters

• apBody (iCharacterBody@) —

Returns:

• void

DestroyCloth

void DestroyCloth(iPhysicsCloth@ apCloth)

Parameters

• apCloth (iPhysicsCloth@) —

Returns:

• void

DestroyController

void DestroyController(iPhysicsController@ apController)

Parameters

• apController (iPhysicsController@) —

Returns:

• void

DestroyJoint

void DestroyJoint(iPhysicsJoint@ apJoint)

Parameters

• apJoint (iPhysicsJoint@) —

Returns:

• void

DestroyRope

void DestroyRope(iPhysicsRope@ apRope)

Parameters

• apRope (iPhysicsRope@) —

Returns:

• void

DestroyShape

void DestroyShape(iCollideShape@ apShape)

Parameters

• apShape (iCollideShape@) —

Returns:

• void

EnableBodiesInAABB

void EnableBodiesInAABB(const cVector3f &in avMin,
                        const cVector3f &in avMax,
                        bool abEnabled)

Parameters

• avMin (cVector3f) —
• avMax (cVector3f) —
• abEnabled (bool) —

Returns:

• void

FadeoutAllLoopSounds

void FadeoutAllLoopSounds(float afFadeSpeed)

Parameters

• afFadeSpeed (float) —

Returns:

• void

GetAccuracyLevel

ePhysicsAccuracy GetAccuracyLevel()

Returns:

• ePhysicsAccuracy—

GetBodiesInAABB

void GetBodiesInAABB(const cVector3f &in avMin,
                     const cVector3f &in avMax,
                     iPhysicsBody@ apBodyVec)

Parameters

• avMin (cVector3f) —
• avMax (cVector3f) —
• apBodyVec (iPhysicsBody@) —

Returns:

• void

GetBody

iPhysicsBody@ GetBody(const tString &in asName)

Parameters

• asName (tString) —

Returns:

• iPhysicsBody@—

GetCharacterBody

iPhysicsBody@ GetCharacterBody(const tString &in asName)

Parameters

• asName (tString) —

Returns:

• iPhysicsBody@—

GetCharacterBodyFromID

iCharacterBody@ GetCharacterBodyFromID(tID aID)

Parameters

• aID (tID) —

Returns:

• iCharacterBody@—

GetCloth

iPhysicsCloth@ GetCloth(const tString &in asName)

Parameters

• asName (tString) —

Returns:

• iPhysicsCloth@—

GetClothFromUniqueID

iPhysicsCloth@ GetClothFromUniqueID(int alID)

Parameters

• alID (int) —

Returns:

• iPhysicsCloth@—

GetGravity

cVector3f GetGravity()

Returns:

• cVector3f—

GetJoint

iPhysicsJoint@ GetJoint(const tString &in asName)

Parameters

• asName (tString) —

Returns:

• iPhysicsJoint@—

GetMaterialFromId

iPhysicsMaterial@ GetMaterialFromId(int alId)

Parameters

• alId (int) —

Returns:

• iPhysicsMaterial@—

GetMaterialFromName

iPhysicsMaterial@ GetMaterialFromName(const tString &in asName)

Parameters

• asName (tString) —

Returns:

• iPhysicsMaterial@—

GetMaxTimeStep

float GetMaxTimeStep()

Returns:

• float—

GetNumberOfThreads

int GetNumberOfThreads()

Returns:

• int—

GetPhysicsBodyFromID

iPhysicsBody@ GetPhysicsBodyFromID(tID aID)

Parameters

• aID (tID) —

Returns:

• iPhysicsBody@—

GetPhysicsJointFromID

iPhysicsJoint@ GetPhysicsJointFromID(tID aID)

Parameters

• aID (tID) —

Returns:

• iPhysicsJoint@—

GetRope

iPhysicsRope@ GetRope(const tString &in asName)

Parameters

• asName (tString) —

Returns:

• iPhysicsRope@—

GetRopeFromUniqueID

iPhysicsRope@ GetRopeFromUniqueID(int alID)

Parameters

• alID (int) —

Returns:

• iPhysicsRope@—

GetWorldSizeMax

cVector3f GetWorldSizeMax()

Returns:

• cVector3f—

GetWorldSizeMin

cVector3f GetWorldSizeMin()

Returns:

• cVector3f—

JointExists

bool JointExists(iPhysicsJoint@ apJoint)

Parameters

• apJoint (iPhysicsJoint@) —

Returns:

• bool—

LoadMeshShapeFromBuffer

iCollideShape@ LoadMeshShapeFromBuffer(cBinaryBuffer@ apBuffer)

Parameters

• apBuffer (cBinaryBuffer@) —

Returns:

• iCollideShape@—

PostUpdate

void PostUpdate(float afTimeStep)

Parameters

• afTimeStep (float) —

Returns:

• void

RenderDebugGeometry

void RenderDebugGeometry(iLowLevelGraphics@ apLowLevel)

Parameters

• apLowLevel (iLowLevelGraphics@) —

Returns:

• void

RenderShapeDebugGeometry

void RenderShapeDebugGeometry(iCollideShape@ apShape,
                              const cMatrixf &in a_mtxTransform,
                              iLowLevelGraphics@ apLowLevel,
                              const cColor &in aColor)

Parameters

• apShape (iCollideShape@) —
• a_mtxTransform (cMatrixf) —
• apLowLevel (iLowLevelGraphics@) —
• aColor (cColor) —

Returns:

• void

SaveMeshShapeToBuffer

void SaveMeshShapeToBuffer(iCollideShape@ apMeshShape,
                           cBinaryBuffer@ apBuffer)

Parameters

• apMeshShape (iCollideShape@) —
• apBuffer (cBinaryBuffer@) —

Returns:

• void

SetAccuracyLevel

void SetAccuracyLevel(ePhysicsAccuracy aAccuracy)

Parameters

• aAccuracy (ePhysicsAccuracy) —

Returns:

• void

SetGravity

void SetGravity(const cVector3f &in avGravity)

Parameters

• avGravity (cVector3f) —

Returns:

• void

SetMaxTimeStep

void SetMaxTimeStep(float afTimeStep)

Parameters

• afTimeStep (float) —

Returns:

• void

SetNumberOfThreads

void SetNumberOfThreads(int alThreads)

Parameters

• alThreads (int) —

Returns:

• void

SetWorldSize

void SetWorldSize(const cVector3f &in avMin,
                  const cVector3f &in avMax)

Parameters

• avMin (cVector3f) —
• avMax (cVector3f) —

Returns:

• void

References

• HPL3/Amnesia: Rebirth/Scripting/Scripting Api ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/cLuxMap ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/cMeshEntity ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/cSubMesh ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/cWorld ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/Scripting Api/cPhysics ‎ (← links)

See all references...