HPL3/Amnesia: Rebirth/Scripting/cLuxHandPlacement

From Frictional Wiki
< HPL3‎ | Amnesia: Rebirth‎ | Scripting
Revision as of 22:32, 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== cLuxHandPlacement has no public fields. =...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

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

Fields

cLuxHandPlacement has no public fields.

Functions

Return Type Function And Description
void FadeIn(float afTime)
void FadeOut(float afTime)
iLuxEntity GetEntity()
cMatrixf GetPreMatrix(eLuxHand aHand, int alBone)
int GetType()
bool IsActive()
void LoadFromVariables(cResourceVarsObject@ apVars)
void RemoveTarget(eLuxHand aHand)
void SetActive(bool abX)
void SetFade(eLuxHand aHand, float afFade)
void SetMaxTargetDistance(eLuxHand aHand, float afValue)
void SetTarget(eLuxHand aHand, const cVector3f &in avPos)
void SetTarget(eLuxHand aHand, const cVector3f &in avPos, const cVector3f &in avNormal)
void SetTargetCapsule(eLuxHand aHand, const cVector3f &in avStart, const cVector3f &in avEnd, float afRadius)
void SetTargetEntity(eLuxHand aHand, const tString &in asEntity)
void SetTargetLine(eLuxHand aHand, const cVector3f &in avStart, const cVector3f &in avEnd)
void SetTargetLine(eLuxHand aHand, const cVector3f &in avStart, const cVector3f &in avEnd, const cVector3f &in avNormal)
void SetTargetPlane(eLuxHand aHand, const cPlanef &in avPlane)
void SetTargetSphere(eLuxHand aHand, const cVector3f &in avPos, float afRadius)

Details

FadeIn

void FadeIn(float afTime)


Parameters

  • afTime (float) —

Returns:

  • void

FadeOut

void FadeOut(float afTime)


Parameters

  • afTime (float) —

Returns:

  • void

GetEntity

iLuxEntity@ GetEntity()

Returns:

  • iLuxEntity@

GetPreMatrix

cMatrixf GetPreMatrix(eLuxHand aHand,
                      int alBone)


Parameters

Returns:

  • cMatrixf

GetType

int GetType()

Returns:

  • int

IsActive

bool IsActive()

Returns:

  • bool

LoadFromVariables

void LoadFromVariables(cResourceVarsObject@ apVars)


Parameters

Returns:

  • void

RemoveTarget

void RemoveTarget(eLuxHand aHand)


Parameters

Returns:

  • void

SetActive

void SetActive(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

SetFade

void SetFade(eLuxHand aHand,
             float afFade)


Parameters

Returns:

  • void

SetMaxTargetDistance

void SetMaxTargetDistance(eLuxHand aHand,
                          float afValue)


Parameters

  • aHand (eLuxHand) —
  • afValue (float) —

Returns:

  • void

SetTarget

void SetTarget(eLuxHand aHand,
               const cVector3f &in avPos)


Parameters

Returns:

  • void

SetTarget

void SetTarget(eLuxHand aHand,
               const cVector3f &in avPos,
               const cVector3f &in avNormal)


Parameters

Returns:

  • void

SetTargetCapsule

void SetTargetCapsule(eLuxHand aHand,
                      const cVector3f &in avStart,
                      const cVector3f &in avEnd,
                      float afRadius)


Parameters

Returns:

  • void

SetTargetEntity

void SetTargetEntity(eLuxHand aHand,
                     const tString &in asEntity)


Parameters

Returns:

  • void

SetTargetLine

void SetTargetLine(eLuxHand aHand,
                   const cVector3f &in avStart,
                   const cVector3f &in avEnd)


Parameters

Returns:

  • void

SetTargetLine

void SetTargetLine(eLuxHand aHand,
                   const cVector3f &in avStart,
                   const cVector3f &in avEnd,
                   const cVector3f &in avNormal)


Parameters

Returns:

  • void

SetTargetPlane

void SetTargetPlane(eLuxHand aHand,
                    const cPlanef &in avPlane)


Parameters

Returns:

  • void

SetTargetSphere

void SetTargetSphere(eLuxHand aHand,
                     const cVector3f &in avPos,
                     float afRadius)


Parameters

Returns:

  • void

References

See all references...