HPL3/Amnesia: Rebirth/Scripting/iPhysicsJoint

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

Fields

iPhysicsJoint has no public fields.

Functions

Return Type	Function And Description
void	Break()
bool	GetAllowPositionReset()
float	GetAngle()
cVector3f	GetAngularVelocity()
iPhysicsBody	GetChildBody()
bool	GetCollideBodies()
float	GetDistance()
float	GetForceSize()
tID	GetID()
bool	GetLimitAutoSleep()
tString	GetName()
iPhysicsBody	GetParentBody()
cVector3f	GetPinDir()
cVector3f	GetPivotPoint()
bool	GetStickyMaxLimit()
bool	GetStickyMinLimit()
float	GetStiffness()
ePhysicsJointType	GetType()
int	GetUniqueID()
cVector3f	GetVelocity()
bool	IsBreakable()
bool	IsBroken()
void	RemoveBody(iPhysicsBody@ apBody)
void	SetAllowPositionReset(bool abX)
void	SetBreakable(bool abX)
void	SetCollideBodies(bool abX)
void	SetLimitAutoSleep(bool abX)
void	SetMaxLimitSound(const tString &in asSound, float afMinSpeed)
void	SetMinLimitSound(const tString &in asSound, float afMinSpeed)
void	SetMinMoveSpeed(float afX)
void	SetMoveSound(tString &in asName)
void	SetMoveSpeedType(ePhysicsJointSpeed aType)
void	SetStickyMaxLimit(bool abX)
void	SetStickyMinLimit(bool abX)
void	SetStiffness(float afX)

Details

Break

void Break()

Returns:

• void

GetAllowPositionReset

bool GetAllowPositionReset()

Returns:

• bool—

GetAngle

float GetAngle()

Returns:

• float—

GetAngularVelocity

cVector3f GetAngularVelocity()

Returns:

• cVector3f—

GetChildBody

iPhysicsBody@ GetChildBody()

Returns:

• iPhysicsBody@—

GetCollideBodies

bool GetCollideBodies()

Returns:

• bool—

GetDistance

float GetDistance()

Returns:

• float—

GetForceSize

float GetForceSize()

Returns:

• float—

GetID

tID GetID()

Returns:

• tID—

GetLimitAutoSleep

bool GetLimitAutoSleep()

Returns:

• bool—

GetName

const tString& GetName()

Returns:

• const tString&—

GetParentBody

iPhysicsBody@ GetParentBody()

Returns:

• iPhysicsBody@—

GetPinDir

const cVector3f& GetPinDir()

Returns:

• const cVector3f&—

GetPivotPoint

const cVector3f& GetPivotPoint()

Returns:

• const cVector3f&—

GetStickyMaxLimit

bool GetStickyMaxLimit()

Returns:

• bool—

GetStickyMinLimit

bool GetStickyMinLimit()

Returns:

• bool—

GetStiffness

float GetStiffness()

Returns:

• float—

GetType

ePhysicsJointType GetType()

Returns:

• ePhysicsJointType—

GetUniqueID

int GetUniqueID()

Returns:

• int—

GetVelocity

cVector3f GetVelocity()

Returns:

• cVector3f—

IsBreakable

bool IsBreakable()

Returns:

• bool—

IsBroken

bool IsBroken()

Returns:

• bool—

RemoveBody

void RemoveBody(iPhysicsBody@ apBody)

Parameters

• apBody (iPhysicsBody@) —

Returns:

• void

SetAllowPositionReset

void SetAllowPositionReset(bool abX)

Parameters

• abX (bool) —

Returns:

• void

SetBreakable

void SetBreakable(bool abX)

Parameters

• abX (bool) —

Returns:

• void

SetCollideBodies

void SetCollideBodies(bool abX)

Parameters

• abX (bool) —

Returns:

• void

SetLimitAutoSleep

void SetLimitAutoSleep(bool abX)

Parameters

• abX (bool) —

Returns:

• void

SetMaxLimitSound

void SetMaxLimitSound(const tString &in asSound,
                      float afMinSpeed)

Parameters

• asSound (tString) —
• afMinSpeed (float) —

Returns:

• void

SetMinLimitSound

void SetMinLimitSound(const tString &in asSound,
                      float afMinSpeed)

Parameters

• asSound (tString) —
• afMinSpeed (float) —

Returns:

• void

SetMinMoveSpeed

void SetMinMoveSpeed(float afX)

Parameters

• afX (float) —

Returns:

• void

SetMoveSound

void SetMoveSound(tString &in asName)

Parameters

• asName (tString) —

Returns:

• void

SetMoveSpeedType

void SetMoveSpeedType(ePhysicsJointSpeed aType)

Parameters

• aType (ePhysicsJointSpeed) —

Returns:

• void

SetStickyMaxLimit

void SetStickyMaxLimit(bool abX)

Parameters

• abX (bool) —

Returns:

• void

SetStickyMinLimit

void SetStickyMinLimit(bool abX)

Parameters

• abX (bool) —

Returns:

• void

SetStiffness

void SetStiffness(float afX)

Parameters

• afX (float) —

Returns:

• void

References

• HPL3/Amnesia: Rebirth/Scripting/Scripting Api ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/cLuxProp ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/iPhysicsBody ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/iPhysicsWorld ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/Scripting Api/cLux ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/Scripting Api/cPhysics ‎ (← links)

See all references...