HPL3/Amnesia: Rebirth/Scripting/iPhysicsJointHinge

From Frictional Wiki
< HPL3‎ | Amnesia: Rebirth‎ | Scripting
Revision as of 23:44, 15 November 2020 by Abion47 (talk | contribs) (Created page with "{{ScriptingStub}} Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki! ==Fields== iPhysicsJointHinge has no public fields....")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search
Info icon.png

This page has been automatically generated, but it needs descriptions added to the various fields/functions in order to be complete.

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

Fields

iPhysicsJointHinge 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()
float GetMaxAngle()
float GetMinAngle()
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 SetMaxAngle(float afAngle)
void SetMaxLimitSound(const tString &in asSound, float afMinSpeed)
void SetMinAngle(float afAngle)
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—

GetMaxAngle

float GetMaxAngle()

Returns:

  • float—

GetMinAngle

float GetMinAngle()

Returns:

  • float—

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

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

SetMaxAngle

void SetMaxAngle(float afAngle)


Parameters

  • afAngle (float) —

Returns:

  • void

SetMaxLimitSound

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


Parameters

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

Returns:

  • void

SetMinAngle

void SetMinAngle(float afAngle)


Parameters

  • afAngle (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

Returns:

  • void

SetMoveSpeedType

void SetMoveSpeedType(ePhysicsJointSpeed aType)


Parameters

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

See all references...

Retrieved from "https://wiki.frictionalgames.com/page?title=HPL3/Amnesia:_Rebirth/Scripting/iPhysicsJointHinge&oldid=6080"