HPL3/Amnesia: Rebirth/Scripting/Scripting Api/Joint

From Frictional Wiki
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!

Summary

Return Type Function and Description
void Joint_Break(const tString &in asJointName)
Breaks the specified joint
float Joint_GetForceSize(const tString &in asJointName)
Gets the force magnitude applied to the specified joint
bool Joint_IsBroken(const tString &in asJointName)
Checks if the specified joint is broken
void Joint_SetBreakable(const tString &in asJointName, bool abBreakable)
Sets if the joint should be breakable by force or not

Function Detail

Joint_Break

void Joint_Break(const tString &in asJointName)

Breaks the specified joint.

Parameters

Returns:

  • void

Joint_GetForceSize

float Joint_GetForceSize(const tString &in asJointName)

Gets the force magnitude applied to the specified joint.

Parameters

Returns:

  • float—float, force size

Joint_IsBroken

bool Joint_IsBroken(const tString &in asJointName)

Checks if the specified joint is broken.

Parameters

Returns:

  • bool—bool, true if the joint is broken.

Joint_SetBreakable

void Joint_SetBreakable(const tString &in asJointName,
                        bool abBreakable)

Sets if the joint should be breakable by force or not.

Parameters

  • asJointName (tString) —
  • abBreakable (bool) —

Returns:

  • void
Retrieved from "https://wiki.frictionalgames.com/page?title=HPL3/Amnesia:_Rebirth/Scripting/Scripting_Api/Joint&oldid=6155"