HPL3/Amnesia: Rebirth/Scripting/cLuxPathfinder

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!

Fields

cLuxPathfinder has no public fields.

Functions

Return Type Function And Description
void AddTrackNode(const tString &in asNodeName, float afMinWaitTime, float afMaxWaitTime, const tString &in asAnimName, bool abLoopAnim)
bool BuildPathNodeArrayFromTo(const cVector3f &in avFromPos, const cVector3f &in avToPos)
bool BuildPathNodeArrayToPos(const cVector3f &in avPos)
bool CheckFreePath(const cVector3f &in avStartPos, const cVector3f &in avTargetPos)
void ClearTrackNodes()
int GetCurrentTrackNode()
cLuxTrackNode GetCurrentTrackNodeData()
float GetCurrentTrackWaitTime()
bool GetDebugLOSCastResult(int alIdx)
int GetDebugLOSCastResultNum()
bool GetDebugLOSPathResult(int alIdx)
int GetDebugLOSPathResultNum()
cVector3f GetDebugLOSPoint(int alIdx)
int GetDebugLOSPointNum()
iLuxEntity GetEntity()
cVector3f GetGoalPos()
cVector3f GetNextGoalPos()
cAINode GetNodeAtPos(const cVector3f &in avPos, float afMinDistance, float afMaxDistance, bool abGetClosest, bool abPosToNodeFreeDirectPathCheck, bool abAgentToNodeFreeDirectPathCheck, cAINode@ apSkipNode, int alFreePathRayNum, uint alFreePathFlags, bool abSkipUsedNodes)
cAINode GetNodeAtPos(const cVector3f &in avPos, float afMinDistance, float afMaxDistance, bool abGetClosest, bool abPosToNodeFreeDirectPathCheck, bool abAgentToNodeFreeDirectPathCheck, cAINode@ apSkipNode)
cAINodeContainer GetNodeContainer()
cAINode GetNodeFromName(const tString &in asName)
cAINode GetNodeInCircularSectorAroundPos(const cVector3f &in avPos, float afMinDistance, float afMaxDistance, const cVector3f &in avExcludedSectorDirection, float afExludedSectorAngle, bool abGetClosest, bool abPosToNodeFreeDirectPathCheck, bool abAgentToNodeFreeDirectPathCheck, cAINode@ apSkipNode)
cAINode GetNodeInPosLOS(const cVector3f &in avPos, float afMinDistance, float afMaxDistance, bool abAgentToNodeFreeDirectPathCheck = false)
cAINode GetNodeInPosLOS(const cVector3f &in avPos, const cVector3f &in avLosPos, float afMinDistance, float afMaxDistance, bool abAgentToNodeFreeDirectPathCheck = false)
cAINode GetNodeOutOfSight(const cVector3f &in avPos, float afMinDistance, float afMaxDistance, const cVector3f &in avHideFromPos, const cVector3f &in avExcludedSectorDirection, float afExludedSectorAngle, bool abGetClosest, bool abPosToNodeFreeDirectPathCheck, bool abAgentToNodeFreeDirectPathCheck, cAINode@ apSkipNode)
cAINode GetNodeOutOfSight(const tString &in asCallback, const cVector3f &in avPos, float afMinDistance, float afMaxDistance, const cVector3f &in avHideFromPos, const cVector3f &in avExcludedSectorDirection, float afExludedSectorAngle, bool abGetClosest, bool abPosToNodeFreeDirectPathCheck, bool abAgentToNodeFreeDirectPathCheck, cAINode@ apSkipNode)
cAINode GetPathNode(int alX)
float GetPathNodeArrayDist(int alIdx)
float GetPathNodeArrayFullLength()
cAINode GetPathNodeArrayNode(int alIdx)
int GetPathNodeArraySize()
int GetPathNodeCount()
bool GetTrackActive()
tString GetTrackCallback()
bool GetTrackLoop()
cLuxTrackNode GetTrackNode(int alIdx)
int GetTrackNodeNum()
bool GetTrackPaused()
float GetTrackUpdateFreq()
int GetType()
void GoToNextTrackNode()
bool IsClimbing()
bool IsMoving()
void MoveTo(const cVector3f &in avPos, float afUpdateFreq, bool abExactStopAtEnd, const tString &in asResultCallback = "", bool abCallbackInMap = false)
void MoveToNode(const tString &in asNodeName, float afUpdateFreq, bool abExactStopAtEnd, const tString &in asResultCallback = "", bool abCallbackInMap = false)
void ResetCurrentTrackNode()
void SetClimbWalls(bool abX)
void SetCurrentTrackWaitTime(float afX)
void SetDirectPathMaxDistanceMul(float afX)
void SetEndOfPathCallbackFunc(const tString &in asCallbackFunc)
void SetMaxEdgeDistance(float afX)
void SetMaxEdges(int alX)
void SetMaxHeight(float afX)
void SetMinEdges(int alX)
void SetMoving(bool abX)
void SetNodeContainerName(const tString &in asName)
void SetNodeIsAtCenter(bool abX)
void SetNodeName(const tString &in asName)
void SetTrackLoop(bool abX)
void SetTrackPaused(bool abX)
void StartTrack(bool abLoop, float afUpdateFreq, const tString &in asEndOfTrackCallback, bool abRandom = false)
void Stop()
void StopTrack()

Details

AddTrackNode

void AddTrackNode(const tString &in asNodeName,
                  float afMinWaitTime,
                  float afMaxWaitTime,
                  const tString &in asAnimName,
                  bool abLoopAnim)


Parameters

  • asNodeName (tString) —
  • afMinWaitTime (float) —
  • afMaxWaitTime (float) —
  • asAnimName (tString) —
  • abLoopAnim (bool) —

Returns:

  • void

BuildPathNodeArrayFromTo

bool BuildPathNodeArrayFromTo(const cVector3f &in avFromPos,
                              const cVector3f &in avToPos)


Parameters

Returns:

  • bool—

BuildPathNodeArrayToPos

bool BuildPathNodeArrayToPos(const cVector3f &in avPos)


Parameters

Returns:

  • bool—

CheckFreePath

bool CheckFreePath(const cVector3f &in avStartPos,
                   const cVector3f &in avTargetPos)


Parameters

Returns:

  • bool—

ClearTrackNodes

void ClearTrackNodes()

Returns:

  • void

GetCurrentTrackNode

int GetCurrentTrackNode()

Returns:

  • int—

GetCurrentTrackNodeData

cLuxTrackNode@ GetCurrentTrackNodeData()

Returns:

  • cLuxTrackNode@—

GetCurrentTrackWaitTime

float GetCurrentTrackWaitTime()

Returns:

  • float—

GetDebugLOSCastResult

bool GetDebugLOSCastResult(int alIdx)


Parameters

  • alIdx (int) —

Returns:

  • bool—

GetDebugLOSCastResultNum

int GetDebugLOSCastResultNum()

Returns:

  • int—

GetDebugLOSPathResult

bool GetDebugLOSPathResult(int alIdx)


Parameters

  • alIdx (int) —

Returns:

  • bool—

GetDebugLOSPathResultNum

int GetDebugLOSPathResultNum()

Returns:

  • int—

GetDebugLOSPoint

const cVector3f& GetDebugLOSPoint(int alIdx)


Parameters

  • alIdx (int) —

Returns:

  • const cVector3f&—

GetDebugLOSPointNum

int GetDebugLOSPointNum()

Returns:

  • int—

GetEntity

iLuxEntity@ GetEntity()

Returns:

  • iLuxEntity@—

GetGoalPos

cVector3f GetGoalPos()

Returns:

  • cVector3f—

GetNextGoalPos

cVector3f GetNextGoalPos()

Returns:

  • cVector3f—

GetNodeAtPos

cAINode@ GetNodeAtPos(const cVector3f &in avPos,
                      float afMinDistance,
                      float afMaxDistance,
                      bool abGetClosest,
                      bool abPosToNodeFreeDirectPathCheck,
                      bool abAgentToNodeFreeDirectPathCheck,
                      cAINode@ apSkipNode,
                      int alFreePathRayNum,
                      uint alFreePathFlags,
                      bool abSkipUsedNodes)


Parameters

  • avPos (cVector3f) —
  • afMinDistance (float) —
  • afMaxDistance (float) —
  • abGetClosest (bool) —
  • abPosToNodeFreeDirectPathCheck (bool) —
  • abAgentToNodeFreeDirectPathCheck (bool) —
  • apSkipNode (cAINode@) —
  • alFreePathRayNum (int) —
  • alFreePathFlags (uint) —
  • abSkipUsedNodes (bool) —

Returns:

  • cAINode@—

GetNodeAtPos

cAINode@ GetNodeAtPos(const cVector3f &in avPos,
                      float afMinDistance,
                      float afMaxDistance,
                      bool abGetClosest,
                      bool abPosToNodeFreeDirectPathCheck,
                      bool abAgentToNodeFreeDirectPathCheck,
                      cAINode@ apSkipNode)


Parameters

  • avPos (cVector3f) —
  • afMinDistance (float) —
  • afMaxDistance (float) —
  • abGetClosest (bool) —
  • abPosToNodeFreeDirectPathCheck (bool) —
  • abAgentToNodeFreeDirectPathCheck (bool) —
  • apSkipNode (cAINode@) —

Returns:

  • cAINode@—

GetNodeContainer

cAINodeContainer@ GetNodeContainer()

Returns:

  • cAINodeContainer@—

GetNodeFromName

cAINode@ GetNodeFromName(const tString &in asName)


Parameters

Returns:

  • cAINode@—

GetNodeInCircularSectorAroundPos

cAINode@ GetNodeInCircularSectorAroundPos(const cVector3f &in avPos,
                                          float afMinDistance,
                                          float afMaxDistance,
                                          const cVector3f &in avExcludedSectorDirection,
                                          float afExludedSectorAngle,
                                          bool abGetClosest,
                                          bool abPosToNodeFreeDirectPathCheck,
                                          bool abAgentToNodeFreeDirectPathCheck,
                                          cAINode@ apSkipNode)


Parameters

  • avPos (cVector3f) —
  • afMinDistance (float) —
  • afMaxDistance (float) —
  • avExcludedSectorDirection (cVector3f) —
  • afExludedSectorAngle (float) —
  • abGetClosest (bool) —
  • abPosToNodeFreeDirectPathCheck (bool) —
  • abAgentToNodeFreeDirectPathCheck (bool) —
  • apSkipNode (cAINode@) —

Returns:

  • cAINode@—

GetNodeInPosLOS

cAINode@ GetNodeInPosLOS(const cVector3f &in avPos,
                         float afMinDistance,
                         float afMaxDistance,
                         bool abAgentToNodeFreeDirectPathCheck = false)


Parameters

  • avPos (cVector3f) —
  • afMinDistance (float) —
  • afMaxDistance (float) —
  • abAgentToNodeFreeDirectPathCheck (bool) —

Returns:

  • cAINode@—

GetNodeInPosLOS

cAINode@ GetNodeInPosLOS(const cVector3f &in avPos,
                         const cVector3f &in avLosPos,
                         float afMinDistance,
                         float afMaxDistance,
                         bool abAgentToNodeFreeDirectPathCheck = false)


Parameters

  • avPos (cVector3f) —
  • avLosPos (cVector3f) —
  • afMinDistance (float) —
  • afMaxDistance (float) —
  • abAgentToNodeFreeDirectPathCheck (bool) —

Returns:

  • cAINode@—

GetNodeOutOfSight

cAINode@ GetNodeOutOfSight(const cVector3f &in avPos,
                           float afMinDistance,
                           float afMaxDistance,
                           const cVector3f &in avHideFromPos,
                           const cVector3f &in avExcludedSectorDirection,
                           float afExludedSectorAngle,
                           bool abGetClosest,
                           bool abPosToNodeFreeDirectPathCheck,
                           bool abAgentToNodeFreeDirectPathCheck,
                           cAINode@ apSkipNode)


Parameters

  • avPos (cVector3f) —
  • afMinDistance (float) —
  • afMaxDistance (float) —
  • avHideFromPos (cVector3f) —
  • avExcludedSectorDirection (cVector3f) —
  • afExludedSectorAngle (float) —
  • abGetClosest (bool) —
  • abPosToNodeFreeDirectPathCheck (bool) —
  • abAgentToNodeFreeDirectPathCheck (bool) —
  • apSkipNode (cAINode@) —

Returns:

  • cAINode@—

GetNodeOutOfSight

cAINode@ GetNodeOutOfSight(const tString &in asCallback,
                           const cVector3f &in avPos,
                           float afMinDistance,
                           float afMaxDistance,
                           const cVector3f &in avHideFromPos,
                           const cVector3f &in avExcludedSectorDirection,
                           float afExludedSectorAngle,
                           bool abGetClosest,
                           bool abPosToNodeFreeDirectPathCheck,
                           bool abAgentToNodeFreeDirectPathCheck,
                           cAINode@ apSkipNode)


Parameters

  • asCallback (tString) —
  • avPos (cVector3f) —
  • afMinDistance (float) —
  • afMaxDistance (float) —
  • avHideFromPos (cVector3f) —
  • avExcludedSectorDirection (cVector3f) —
  • afExludedSectorAngle (float) —
  • abGetClosest (bool) —
  • abPosToNodeFreeDirectPathCheck (bool) —
  • abAgentToNodeFreeDirectPathCheck (bool) —
  • apSkipNode (cAINode@) —

Returns:

  • cAINode@—

GetPathNode

cAINode@ GetPathNode(int alX)


Parameters

  • alX (int) —

Returns:

  • cAINode@—

GetPathNodeArrayDist

float GetPathNodeArrayDist(int alIdx)


Parameters

  • alIdx (int) —

Returns:

  • float—

GetPathNodeArrayFullLength

float GetPathNodeArrayFullLength()

Returns:

  • float—

GetPathNodeArrayNode

cAINode@ GetPathNodeArrayNode(int alIdx)


Parameters

  • alIdx (int) —

Returns:

  • cAINode@—

GetPathNodeArraySize

int GetPathNodeArraySize()

Returns:

  • int—

GetPathNodeCount

int GetPathNodeCount()

Returns:

  • int—

GetTrackActive

bool GetTrackActive()

Returns:

  • bool—

GetTrackCallback

const tString& GetTrackCallback()

Returns:

  • const tString&—

GetTrackLoop

bool GetTrackLoop()

Returns:

  • bool—

GetTrackNode

cLuxTrackNode@ GetTrackNode(int alIdx)


Parameters

  • alIdx (int) —

Returns:

  • cLuxTrackNode@—

GetTrackNodeNum

int GetTrackNodeNum()

Returns:

  • int—

GetTrackPaused

bool GetTrackPaused()

Returns:

  • bool—

GetTrackUpdateFreq

float GetTrackUpdateFreq()

Returns:

  • float—

GetType

int GetType()

Returns:

  • int—

GoToNextTrackNode

void GoToNextTrackNode()

Returns:

  • void

IsClimbing

bool IsClimbing()

Returns:

  • bool—

IsMoving

bool IsMoving()

Returns:

  • bool—

MoveTo

void MoveTo(const cVector3f &in avPos,
            float afUpdateFreq,
            bool abExactStopAtEnd,
            const tString &in asResultCallback = "",
            bool abCallbackInMap = false)


Parameters

  • avPos (cVector3f) —
  • afUpdateFreq (float) —
  • abExactStopAtEnd (bool) —
  • asResultCallback (tString) —
  • abCallbackInMap (bool) —

Returns:

  • void

MoveToNode

void MoveToNode(const tString &in asNodeName,
                float afUpdateFreq,
                bool abExactStopAtEnd,
                const tString &in asResultCallback = "",
                bool abCallbackInMap = false)


Parameters

  • asNodeName (tString) —
  • afUpdateFreq (float) —
  • abExactStopAtEnd (bool) —
  • asResultCallback (tString) —
  • abCallbackInMap (bool) —

Returns:

  • void

ResetCurrentTrackNode

void ResetCurrentTrackNode()

Returns:

  • void

SetClimbWalls

void SetClimbWalls(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

SetCurrentTrackWaitTime

void SetCurrentTrackWaitTime(float afX)


Parameters

  • afX (float) —

Returns:

  • void

SetDirectPathMaxDistanceMul

void SetDirectPathMaxDistanceMul(float afX)


Parameters

  • afX (float) —

Returns:

  • void

SetEndOfPathCallbackFunc

void SetEndOfPathCallbackFunc(const tString &in asCallbackFunc)


Parameters

Returns:

  • void

SetMaxEdgeDistance

void SetMaxEdgeDistance(float afX)


Parameters

  • afX (float) —

Returns:

  • void

SetMaxEdges

void SetMaxEdges(int alX)


Parameters

  • alX (int) —

Returns:

  • void

SetMaxHeight

void SetMaxHeight(float afX)


Parameters

  • afX (float) —

Returns:

  • void

SetMinEdges

void SetMinEdges(int alX)


Parameters

  • alX (int) —

Returns:

  • void

SetMoving

void SetMoving(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

SetNodeContainerName

void SetNodeContainerName(const tString &in asName)


Parameters

Returns:

  • void

SetNodeIsAtCenter

void SetNodeIsAtCenter(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

SetNodeName

void SetNodeName(const tString &in asName)


Parameters

Returns:

  • void

SetTrackLoop

void SetTrackLoop(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

SetTrackPaused

void SetTrackPaused(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

StartTrack

void StartTrack(bool abLoop,
                float afUpdateFreq,
                const tString &in asEndOfTrackCallback,
                bool abRandom = false)


Parameters

  • abLoop (bool) —
  • afUpdateFreq (float) —
  • asEndOfTrackCallback (tString) —
  • abRandom (bool) —

Returns:

  • void

Stop

void Stop()

Returns:

  • void

StopTrack

void StopTrack()

Returns:

  • void

References

See all references...

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