Frictional Game Wiki

<h2>helper_ai.hps</h2> <div class="level2"> </div> <h5>Agent_SetStaticCollider</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Agent_SetStaticCollider<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asAgentName<span class="sy0">,</span> bool abX<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Set if the agent will collide with the environment (objects and stuff will still collide with it!) </p> <ul> <li class="level1"> <b>asAgentName</b>: name of the agent. Wildcard supported.</li> <li class="level1"> <b>abX</b>: If the character should be static and NOT move about.</li> </ul> <hr /> </div> <h5>Agent_SetSensesActive</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Agent_SetSensesActive<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asAgentName<span class="sy0">,</span> bool abX<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Set if the agent should have its senses (hearing/vision/etc) enabled. Usually implemented on a specific basis. </p> <ul> <li class="level1"> <b>asAgentName</b>: name of the agent. Wildcard supported.</li> <li class="level1"> <b>abX</b>: If the senses should be active.</li> </ul> <hr /> </div> <h5>Agent_RevealPlayerPosition</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Agent_RevealPlayerPosition<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asAgentName<span class="sy0">,</span> bool bForceRedetect<span class="sy0">=</span><span class="kw2">false</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Reveals the player's current position to the agent. </p> <ul> <li class="level1"> <b>asAgentName</b>: name of the agent. Wildcard supported.</li> <li class="level1"> <b>bForceRedetect</b>: true = forces the agent to detect the player again.</li> </ul> <hr /> </div> <h5>Agent_SetViewRangeMul</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Agent_SetViewRangeMul<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asAgentName<span class="sy0">,</span> <span class="kw4">float</span> afRangeMul<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Sets the view range multiplier of the specified agent </p> <ul> <li class="level1"> <b>asAgentName</b>: name of the agent. Wildcard supported.</li> <li class="level1"> <b>afRangeMul</b>: the range multiplier to set.</li> </ul> <hr /> </div> <h5>Agent_FaceEntity</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Agent_FaceEntity<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asAgentName<span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asLookAtTarget<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Instantly sets the yaw of the agent to make it look at the specified entity. </p> <ul> <li class="level1"> <b>asAgentName</b>: name of the agent. Wildcard supported.</li> <li class="level1"> <b>asLookAtTarget</b>: name of entity to look at.</li> </ul> <hr /> </div> <h5>Agent_TeleportFeetToEntity</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Agent_TeleportFeetToEntity<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asAgentName<span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asTargetName<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Teleport the agent's foot position to a specific other entity. </p> <ul> <li class="level1"> <b>asAgentName</b>: name of the entity to teleport.</li> <li class="level1"> <b>asTargetName</b>: name of the entity to teleport to.</li> </ul> <hr /> </div> <h5>Agent_SetAutoDisableWhenOutOfSightActive</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Agent_SetAutoDisableWhenOutOfSightActive<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asAgentName<span class="sy0">,</span> bool abActive<span class="sy0">,</span> <span class="kw4">float</span> afMinDistance<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> When active, the agent will be a disabled (SetActive(false)) when a certain distance away from the player and no longer seen. </p> <ul> <li class="level1"> <b>asAgentName</b>: name of the agent.Wildcard supported.</li> <li class="level1"> <b>abActive</b>: if the disabling is active</li> <li class="level1"> <b>afMinDistance</b>: The minimum distance from the player for this to happen.</li> </ul> <hr /> </div> <h5>Agent_SetAutoDisableCallback</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Agent_SetAutoDisableCallback<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asAgentName<span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asCallbackFunc<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Sets the function that is called when the disabling made by Agent_SetAutoDisableWhenOutOfSightActive happens </p> <ul> <li class="level1"> <b>asAgentName</b>: name of the agent.Wildcard supported.</li> <li class="level1"> <b>asCallbackFunc</b>: Function called when the disabling happens. syntax: void f(const tString&in asEntityName)</li> </ul> <hr /> </div> <h5>Agent_PlayerDetected</h5> <div class="level5"> <pre class="code c++">bool Agent_PlayerDetected<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asAgentName<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Checks if the agent has dected the player </p> <ul> <li class="level1"> <b>asAgentName</b>: name of the agent.</li> </ul> <hr /> </div> <h5>CharMover_SetDirection</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> CharMover_SetDirection<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asEntityName<span class="sy0">,</span> eLuxCharMoveDirection aDir<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Sets the direction used by a character </p> <ul> <li class="level1"> <b>asEntityName</b>: name of the entity with the CharMover.</li> <li class="level1"> <b>aDir</b>: direction that the character will face when walking</li> </ul> <hr /> </div> <h5>CharMover_TurnToEntity</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> CharMover_TurnToEntity<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asEntityName<span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asTurnToEntityName<span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asTurnedToGoalCallbackFunc<span class="sy0">=</span>""<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Turns the character to a specifc entity. Broadcasts the entity message eLuxEntityMessage_TurningDone when done. </p> <ul> <li class="level1"> <b>asEntityName</b>: name of the entity with the CharMover.</li> <li class="level1"> <b>asTurnToEntityName</b>: the entity which center will be turn towards</li> <li class="level1"> <b>asTurnedToGoalCallbackFunc</b>: function called when it has turned to the goal. Syntax: void Func(const tString& in asEntityName)</li> </ul> <hr /> </div> <h5>CharMover_TurnInstantlyToEntity</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> CharMover_TurnInstantlyToEntity<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asEntityName<span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asTurnToEntityName<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Turns the character directly to a specifc entity. Broadcasts the entity message eLuxEntityMessage_TurningDone when done. </p> <ul> <li class="level1"> <b>asEntityName</b>: name of the entity with the CharMover.</li> <li class="level1"> <b>asTurnToEntityName</b>: the entity which center will be turn towards</li> </ul> <hr /> </div> <h5>CharMover_MoveToEntity</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> CharMover_MoveToEntity<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asEntityName<span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asMoveToEntityName<span class="sy0">,</span> <span class="kw4">const</span> cVector3f <span class="sy0">&</span>in avOffset<span class="sy0">=</span>cVector3f<span class="br0">(</span><span class="nu0">0</span><span class="br0">)</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Moves the character to a entity. Note that for non-flying characters, goal position should be the feet postion. </p> <ul> <li class="level1"> <b>asEntityName</b>: name of the entity with the CharMover.</li> <li class="level1"> <b>asMoveToEntityName</b>: the entity which center will be turn towards</li> <li class="level1"> <b>avOffset</b>: an offset for the move postion.</li> </ul> <hr /> </div> <h5>CharMover_MoveToPos</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> CharMover_MoveToPos<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asEntityName<span class="sy0">,</span> <span class="kw4">const</span> cVector3f <span class="sy0">&</span>in avPosition<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Moves the character to a position. Note that for non-flying characters, goal position should be the feet postion. </p> <ul> <li class="level1"> <b>asEntityName</b>: name of the entity with the CharMover.</li> <li class="level1"> <b>avPosition</b>: position to move to</li> </ul> <hr /> </div> <h5>CharMover_SetSpeedState</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> CharMover_SetSpeedState<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asEntityName<span class="sy0">,</span> <span class="kw4">int</span> alIndex<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Sets the speed state of the character. </p> <ul> <li class="level1"> <b>asEntityName</b>: name of the entity with the CharMover.</li> <li class="level1"> <b>alIndex</b>: speed state index</li> </ul> <hr /> </div> <h5>CharMover_SetUseMoveStateAnimations</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> CharMover_SetUseMoveStateAnimations<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asEntityName<span class="sy0">,</span> bool abX<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> If the charmover should change animations depending based on movement. </p> <ul> <li class="level1"> <b>asEntityName</b>: name of the entity with the CharMover.</li> <li class="level1"> <b>abX</b>: if charmover shouuld take care of animations</li> </ul> <hr /> </div> <h5>CharMover_PlayAnimation</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> CharMover_PlayAnimation<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asEntityName<span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asAnimName<span class="sy0">,</span> <span class="kw4">float</span> afFadeTime<span class="sy0">=</span><span class="nu17">0.3f</span><span class="sy0">,</span> bool abLoop<span class="sy0">=</span><span class="kw2">false</span><span class="sy0">,</span> bool abPlayTransition<span class="sy0">=</span><span class="kw2">true</span><span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asCallback<span class="sy0">=</span>""<span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>CharMover_StopTurning</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> CharMover_StopTurning<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asEntityName<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Stops any turning in the charmover </p> <ul> <li class="level1"> <b>asEntityName</b>: name of the entity with the CharMover.</li> </ul> <hr /> </div> <h5>CharMover_SetTurnRate</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> CharMover_SetTurnRate<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asEntityName<span class="sy0">,</span> <span class="kw4">float</span> afMinBreakAngle<span class="sy0">,</span> <span class="kw4">float</span> afBreakAngleMul<span class="sy0">,</span> <span class="kw4">float</span> afTurnSpeedMul<span class="sy0">,</span> <span class="kw4">float</span> afTurnSpeedMax<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Sets the turning behavior of the charmover. </p> <ul> <li class="level1"> <b>asEntityName</b>: name of the entity with the CharMover.</li> <li class="level1"> <b>afMinBreakAngle</b>: the minimum angle at which the charmover should slow down when turning.</li> <li class="level1"> <b>afBreakAngleMul</b>: value multiplied by the angle to calculate how much the charmover should slow down when turning.</li> <li class="level1"> <b>afTurnSpeedMul</b>: value multiplied by the angle to calculate how fast the charmover should turn.</li> <li class="level1"> <b>afTurnSpeedMax</b>: the max turn speed.</li> </ul> <hr /> </div> <h5>CharMover_SetMaxForwardSpeed</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> CharMover_SetMaxForwardSpeed<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asEntityName<span class="sy0">,</span> <span class="kw4">float</span> afMaxSpeed<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Sets the max forward speed of the CharMover. </p> <ul> <li class="level1"> <b>asEntityName</b>: name of the entity with the CharMover.</li> <li class="level1"> <b>afMaxSpeed</b>: max forward speed to set.</li> </ul> <hr /> </div> <h5>CharMover_SetWallAvoidanceActive</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> CharMover_SetWallAvoidanceActive<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asEntityName<span class="sy0">,</span> bool abX<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Enables or disables wall avoidance on the specified CharMover. </p> <ul> <li class="level1"> <b>asEntityName</b>: name of the entity with the CharMover.</li> <li class="level1"> <b>abX</b>: the state to set.</li> </ul> <hr /> </div> <h5>Pathfinder_MoveTo</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Pathfinder_MoveTo<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asEntityName<span class="sy0">,</span> <span class="kw4">const</span> cVector3f <span class="sy0">&</span>in avPos<span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asCallbackFunc<span class="sy0">,</span> <span class="kw4">float</span> afUpdateFreq<span class="sy0">=</span><span class="nu0">0</span><span class="sy0">,</span> bool abExactStopAtEnd<span class="sy0">=</span><span class="kw2">true</span><span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asResultCallbackFunc<span class="sy0">=</span>""<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Moves an entity containing a Pathfinder component to a position. The entity message eLuxEntityMessage_EndOfPath is broadcasted when complete. </p> <ul> <li class="level1"> <b>asEntityName</b>: name of the entity with the pathfinder.</li> <li class="level1"> <b>avPos</b>: position to move to.</li> <li class="level1"> <b>asCallbackFunc</b>: The name of callback called when end is reach. Syntax: void Func(const tString& in asEntityName, bool abReachedEnd)</li> <li class="level1"> <b>afUpdateFreq</b>: The number of times per second that the path will be updated. O or below means never update.</li> <li class="level1"> <b>abExactStopAtEnd</b>: If the goal position should be hit exactly.</li> <li class="level1"> <b>asResultCallbackFunc</b>: The name of callback called when the pathfinding has been performed. Syntax: void Func(bool abSuccesful)</li> </ul> <hr /> </div> <h5>Pathfinder_MoveToNode</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Pathfinder_MoveToNode<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asEntityName<span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asNodeName<span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asCallbackFunc<span class="sy0">=</span>""<span class="sy0">,</span> <span class="kw4">float</span> afUpdateFreq<span class="sy0">=</span><span class="nu0">0</span><span class="sy0">,</span> bool abExactStopAtEnd<span class="sy0">=</span><span class="kw2">true</span><span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asResultCallbackFunc<span class="sy0">=</span>""<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Moves an entity containing a Pathfinder component to a node. The entity message eLuxEntityMessage_EndOfPath is broadcasted when complete. </p> <ul> <li class="level1"> <b>asEntityName</b>: name of the entity with the pathfinder.</li> <li class="level1"> <b>asNodeName</b>: name of the node to move to.</li> <li class="level1"> <b>asCallbackFunc</b>: The name of callback called when end is reach. Syntax: void Func(const tString& in asEntityName, bool abReachedEnd)</li> <li class="level1"> <b>afUpdateFreq</b>: The number of times per second that the path will be updated. O or below means never update.</li> <li class="level1"> <b>abExactStopAtEnd</b>: If the goal node should be hit exactly.</li> <li class="level1"> <b>asResultCallbackFunc</b>: The name of callback called when the pathfinding has been performed. Syntax: void Func(bool abSuccesful)</li> </ul> <hr /> </div> <h5>Pathfinder_MoveToEntity</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Pathfinder_MoveToEntity<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asPathfinderName<span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asEntityName<span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asCallbackFunc<span class="sy0">,</span> <span class="kw4">float</span> afUpdateFreq<span class="sy0">=</span><span class="nu0">0</span><span class="sy0">,</span> bool abExactStopAtEnd<span class="sy0">=</span><span class="kw2">true</span><span class="sy0">,</span> <span class="kw4">const</span> cVector3f <span class="sy0">&</span>in avGoalPosOffset<span class="sy0">=</span>cVector3f<span class="br0">(</span><span class="nu0">0</span><span class="br0">)</span><span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asResultCallbackFunc<span class="sy0">=</span>""<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Moves an entity containing a Pathfinder component to a entity. The entity message eLuxEntityMessage_EndOfPath is broadcasted when complete. </p> <ul> <li class="level1"> <b>asPathfinderName</b>: name of the entity with the pathfinder.</li> <li class="level1"> <b>asEntityName</b>: name of the entity to move to.</li> <li class="level1"> <b>asCallbackFunc</b>: The name of callback called when end is reach. Syntax: void Funcconst</li> <li class="level1"> <b>afUpdateFreq</b>: The number of times per second that the path will be updated. O or below means never update.</li> <li class="level1"> <b>abExactStopAtEnd</b>: If the goal entity should be hit exactly.</li> <li class="level1"> <b>avGoalPosOffset</b>: if the goal pos should be offset</li> <li class="level1"> <b>asResultCallbackFunc</b>: The name of callback called when the pathfinding has been performed. Syntax: void Func(bool abSuccesful)</li> </ul> <hr /> </div> <h5>Pathfinder_Stop</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Pathfinder_Stop<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asEntityName<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Stops any movement. </p> <ul> <li class="level1"> <b>asEntityName</b>: name of the entity with the pathfinder.</li> </ul> <hr /> </div> <h5>Pathfinder_SetEndCallback</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Pathfinder_SetEndCallback<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asEntityName<span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asCallbackFunc<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Sets the callback for when the pathfinder has reached its goal. </p> <ul> <li class="level1"> <b>asEntityName</b>: name of the entity with the pathfinder.</li> <li class="level1"> <b>asCallbackFunc</b>: The name of callback called when end is reach. Syntax: void Funcconst</li> </ul> <hr /> </div> <h5>Pathfinder_IsMoving</h5> <div class="level5"> <pre class="code c++">bool Pathfinder_IsMoving<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asEntityName<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Checks if the pathfinder is currently moving. </p> <ul> <li class="level1"> <b>asEntityName</b>: name of the entity with the pathfinder.</li> </ul> <hr /> </div> <h5>Pathfinder_Track_Clear</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Pathfinder_Track_Clear<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asEntityName<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Clears all track nodes and stops track. </p> <ul> <li class="level1"> <b>asEntityName</b>: name of the entity with the pathfinder.</li> </ul> <hr /> </div> <h5>Pathfinder_Track_Add</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Pathfinder_Track_Add<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asEntityName<span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asNodeName<span class="sy0">,</span> <span class="kw4">float</span> afMinWaitTime<span class="sy0">=</span><span class="nu0">0</span><span class="sy0">,</span> <span class="kw4">float</span> afMaxWaitTime<span class="sy0">=-</span><span class="nu0">1</span><span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asAnimName<span class="sy0">=</span>""<span class="sy0">,</span> bool abLoopAnim<span class="sy0">=</span><span class="kw2">false</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Adds a track node to be followed. </p> <ul> <li class="level1"> <b>asEntityName</b>: name of the entity with the pathfinder.</li> <li class="level1"> <b>asNodeName</b>: Name of the path node to be added.</li> <li class="level1"> <b>afMinWaitTime</b>: minimum time before the entity moves to the next node.</li> <li class="level1"> <b>afMaxWaitTime</b>: maximum time before the entity moves to the next node. If &lt;0, then the value will be same as afMinWaitTime</li> <li class="level1"> <b>asAnimName</b>: animation played when at node, per entity.</li> <li class="level1"> <b>abLoopAnim</b>: if the animtion should be looped, per entity.</li> </ul> <hr /> </div> <h5>Pathfinder_Track_Start</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Pathfinder_Track_Start<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asEntityName<span class="sy0">,</span> bool abLoop<span class="sy0">=</span><span class="kw2">false</span><span class="sy0">,</span> <span class="kw4">float</span> afUpdateFreq<span class="sy0">=</span><span class="nu17">1.0f</span><span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asEndOfTrackCallback<span class="sy0">=</span>""<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Starts a track </p> <ul> <li class="level1"> <b>asEntityName</b>: name of the entity with the pathfinder.</li> <li class="level1"> <b>abLoop</b>: if the path should loop</li> <li class="level1"> <b>afUpdateFreq</b>: the frequency at which the path is recculated</li> <li class="level1"> <b>asEndOfTrackCallback</b>: Callback called when path is over. Syntax: void MyFunc(const tString& in asEntityName)</li> </ul> <hr /> </div> <h5>Pathfinder_Track_Stop</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Pathfinder_Track_Stop<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asEntityName<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Stops the current track. </p> <ul> <li class="level1"> <b>asEntityName</b>: name of the entity with the pathfinder.</li> </ul> <hr /> </div> <h5>BarkMachine_SetActive</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> BarkMachine_SetActive<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asEntityName<span class="sy0">,</span> bool abActive<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Sets if the barkmachine is active (this will only affect random sounds) </p> <ul> <li class="level1"> <b>asEntityName</b>: name of the entity with the barkmachine.</li> <li class="level1"> <b>abActive</b>: if active or not.</li> </ul> <hr /> </div> <h5>BarkMachine_PlayVoice</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> BarkMachine_PlayVoice<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asEntityName<span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asSubject<span class="sy0">,</span> <span class="kw4">int</span> alPrio<span class="sy0">,</span> <span class="kw4">float</span> afMinDistance<span class="sy0">=-</span><span class="nu0">1</span><span class="sy0">,</span> <span class="kw4">float</span> afMaxDistance<span class="sy0">=-</span><span class="nu0">1</span><span class="sy0">,</span> <span class="kw4">float</span> afMaxPlayerListeningRange<span class="sy0">=-</span><span class="nu0">1</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Plays a voice subject as a bark </p> <ul> <li class="level1"> <b>asEntityName</b>: name of the entity with the barkmachine.</li> <li class="level1"> <b>asSubject</b>: the name of the voice subject</li> <li class="level1"> <b>alPrio</b>: the prio of the voice, if there is already one playing in the same scene prio must be higher for this to play.</li> <li class="level1"> <b>afMinDistance</b>: The distance where volume starts getting quiet. If below 0, default is used.</li> <li class="level1"> <b>afMaxDistance</b>: The maximum hearing range. If below 0, default is used.</li> <li class="level1"> <b>afMaxPlayerListeningRange</b>: The maximum that subtitles are displayed. If below 0, default is used.</li> </ul> <hr /> </div> <h5>HeadTracker_SetActive</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> HeadTracker_SetActive<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asEntityName<span class="sy0">,</span> bool abX<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Turns on and off head tracking. </p> <ul> <li class="level1"> <b>asEntityName</b>: name of the entity with the HeadTracker.</li> <li class="level1"> <b>abX</b>: if headtracking is enabled or not</li> </ul> <hr /> </div> <h5>HeadTracker_IsActive</h5> <div class="level5"> <pre class="code c++">bool HeadTracker_IsActive<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asEntityName<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> If head tracking is active or not </p> <ul> <li class="level1"> <b>asEntityName</b>: name of the entity with the HeadTracker.</li> </ul> <hr /> </div> <h5>HeadTracker_SetAngleOffset</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> HeadTracker_SetAngleOffset<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asEntityName<span class="sy0">,</span> <span class="kw4">float</span> afX<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Sets the offset of the headtracker angle useful if the character is not facing in the direction of the meshentity forward vector. </p> <ul> <li class="level1"> <b>asEntityName</b>: name of the entity with the HeadTracker.</li> <li class="level1"> <b>afX</b>: The angle offset, in degrees</li> </ul> <hr /> </div> <h5>HeadTracker_SetTargetEntity</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> HeadTracker_SetTargetEntity<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asEntityName<span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asTargetEntityName<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Sets the target of the head tracking </p> <ul> <li class="level1"> <b>asEntityName</b>: name of the entity with the HeadTracker.</li> <li class="level1"> <b>asTargetEntityName</b>: The target of the tracking</li> </ul> <hr /> </div> <h5>NPC_SetVoiceName</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> NPC_SetVoiceName<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asNpcName<span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asVoiceName<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Sets the voice name for an NPC. This also automatically sets the source of the voice as the npc. </p> <ul> <li class="level1"> <b>asNpcName</b>: name of the NPC.</li> <li class="level1"> <b>asVoiceName</b>: name of the voice as defined in the voicehandler file..</li> </ul> <hr /> </div> <h5>NPC_IsTalking</h5> <div class="level5"> <pre class="code c++">bool NPC_IsTalking<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asNpcName<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Checks if the NPC is being talked to. </p> <ul> <li class="level1"> <b>asNpcName</b>: name of the NPC.</li> </ul> <hr /> </div> <h5>NPC_SetCanBeTalkedTo</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> NPC_SetCanBeTalkedTo<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asNpcName<span class="sy0">,</span> bool abX<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Sets if the NPC can be talked to (interacted with) </p> <ul> <li class="level1"> <b>asNpcName</b>: name of the NPC. Wildcard supported.</li> <li class="level1"> <b>abX</b>: if can be talked to.</li> </ul> <hr /> </div> <h5>NPC_SetMainAnimation</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> NPC_SetMainAnimation<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asNpcName<span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asAnim<span class="sy0">,</span> bool abPlayTransition<span class="sy0">=</span><span class="kw2">true</span><span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asCallbackFunc<span class="sy0">=</span>""<span class="sy0">,</span> <span class="kw4">float</span> afFadeTime<span class="sy0">=</span><span class="nu16">0.5</span><span class="sy0">,</span> bool abGlobalSpace<span class="sy0">=</span><span class="kw2">false</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Sets and plays the main animation of the NPC. This will also turn off any movement animations. </p> <ul> <li class="level1"> <b>asNpcName</b>: name of the NPC. Wildcard supported.</li> <li class="level1"> <b>asAnim</b>: The name of the animation</li> <li class="level1"> <b>abPlayTransition</b>: If a transition animation should be played.</li> <li class="level1"> <b>asCallbackFunc</b>: name of callback function. Only used if there is a transition animation. Syntax void Func(const tString &in asEntityName, const tString &in asAnimName)</li> <li class="level1"> <b>afFadeTime</b>: time it takes to fade to the animation.</li> <li class="level1"> <b>abGlobalSpace</b>: if the animation takes place in global space</li> </ul> <hr /> </div> <h5>NPC_PlayExtraAnimation</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> NPC_PlayExtraAnimation<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asNpcName<span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asAnim<span class="sy0">,</span> <span class="kw4">float</span> afFadeTime<span class="sy0">=</span><span class="nu16">0.3</span><span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asCallbackFunc<span class="sy0">=</span>""<span class="sy0">,</span> bool abGlobalSpace<span class="sy0">=</span><span class="kw2">false</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Plays an extra animation for the NPC. Will return to main animation (see NPC_SetMainAnimation) when done. </p> <ul> <li class="level1"> <b>asNpcName</b>: name of the NPC. Wildcard supported.</li> <li class="level1"> <b>asAnim</b>: The name of the animation</li> <li class="level1"> <b>afFadeTime</b>: The time it takes to fade in the animation.</li> <li class="level1"> <b>asCallbackFunc</b>: name of callback function. Syntax void Func(tString &in asEntityName, tString &in asAnimName)</li> <li class="level1"> <b>abGlobalSpace</b>: the animation will be played in global space coordinates (?)</li> </ul> <hr /> </div> <h5>NPC_StopAllAnimations</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> NPC_StopAllAnimations<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asNpcName<span class="sy0">,</span> <span class="kw4">float</span> afFadeTime<span class="sy0">=</span><span class="nu17">0.0f</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Stops all animations for the NPC. </p> <ul> <li class="level1"> <b>asNpcName</b>: name of the NPC. Wildcard supported.</li> <li class="level1"> <b>afFadeTime</b>: The time it takes to fade out.</li> </ul> <hr /> </div> <h5>NPC_StopExtraAnimation</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> NPC_StopExtraAnimation<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asNpcName<span class="sy0">,</span> <span class="kw4">float</span> afFadeTime<span class="sy0">=</span><span class="nu17">0.0f</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Stops currently playing extra animation for the NPC. </p> <ul> <li class="level1"> <b>asNpcName</b>: name of the NPC. Wildcard supported.</li> <li class="level1"> <b>afFadeTime</b>: The time it takes to fade out.</li> </ul> <hr /> </div> <h5>NPC_PlayEmotion</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> NPC_PlayEmotion<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asNpcName<span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asEmotion<span class="sy0">,</span> <span class="kw4">float</span> afDuration<span class="sy0">,</span> <span class="kw4">float</span> afWeight<span class="sy0">=</span><span class="nu17">1.0f</span><span class="sy0">,</span> <span class="kw4">float</span> afFadeTime<span class="sy0">=</span><span class="nu17">0.25f</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Plays a face emotion for the duration </p> <ul> <li class="level1"> <b>asNpcName</b>: name of the NPC. Wildcard supported.</li> <li class="level1"> <b>asEmotion</b>: name of the emotion, "Smile/Sad/Happy/Surprised/Wink/Wondering/Angry/Worried/Scared"</li> <li class="level1"> <b>afDuration</b>: how long the emotion should be active</li> <li class="level1"> <b>afWeight</b>: how strong the emotion should be</li> <li class="level1"> <b>afFadeTime</b>: fade in and out time for the emotion</li> </ul> <hr /> </div> <h5>NPC_MoveToNode</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> NPC_MoveToNode<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asNpcName<span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asNodeName<span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asCallbackFunc<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Moves the NPC to a path node. </p> <ul> <li class="level1"> <b>asNpcName</b>: name of the NPC. Wildcard supported.</li> <li class="level1"> <b>asNodeName</b>: The name of the path node.</li> <li class="level1"> <b>asCallbackFunc</b>: The name of callback called when end is reach. Syntax: void Func(const tString& in asEntityName, bool abReachedEnd)</li> </ul> <hr /> </div> <h5>Critter_SetGroupEntity</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Critter_SetGroupEntity<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asCritter<span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asGroupEntity<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Sets the entity the critter should flock around </p> <ul> <li class="level1"> <b>asCritter</b>: name of the Critter. Wildcard supported.</li> <li class="level1"> <b>asGroupEntity</b>: The name of the group entity.</li> </ul> <hr /> </div> <h5>Critter_AddExtraEscapeEntity</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Critter_AddExtraEscapeEntity<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asCritter<span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asEscapeEntity<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Adds an entity that the critter should try to avoid the same way it does with the player. (Only implemented in FishSmall right now) </p> <ul> <li class="level1"> <b>asCritter</b>: name of the Critter. Wildcard supported.</li> <li class="level1"> <b>asEscapeEntity</b>: The name of the entity to escape from</li> </ul> <hr /> </div>