Ai goal lead

From Valve Developer Community
Revision as of 00:54, 1 August 2018 by Pinsplash (talk | contribs) (removed {{DISPLAYTITLE}}, covered by the hl2 point template)
Jump to navigation Jump to search

Template:Hl2 point

Entity description

Ai goal lead.png

When activated by a trigger, makes an NPC attempt to lead the player to a target. Optionally, a point can be set for the NPC to wait for the player before beginning to lead the player. The ConceptModifier keyvalues do not appear to be utilized by any of the maps below, but appear to provide some level of access to the NPC Response System.

For examples of its use, see the Half-Life 2 maps:

For more examples of its use, see the Half-Life 2: Lost Coast map: d2_lostcoast

See also:  Vmex for decompiling maps.

Keyvalues

Keyvalues:

AI_LeadGoal:

Target Entity (goal) <targetname>
The name of the entity that the NPC will lead the player to (i.e. an info_target).
Point to wait at if the target's not visible (WaitPointName) <targetname>
If the NPC loses line-of-sight to the player, it will return to this entity (i.e. an info_target).
Wait until player gets this close (WaitDistance) <float>
The player must be within this distance of the NPC before the NPC initially begins leading them.
Lead Distance (LeadDistance) <float>
The player is considered to be too far behind if they're beyond this distance. Past this distance, the leader will nag the player to hurry up.
Retrieve Distance (RetrieveDistance) <float>
The distance from the player that the NPC should return to when retrieving a lagging player. Must be between ('Lead Distance' + 24) and ('Lead Distance' * 4) to avoid the leader ping-ponging.
Success Distance (SuccessDistanc)) <float>
The distance from the player (to the NPC) that the player must be within for the Lead to succeed, once the NPC has reached the goal. If set to 0, it'll use the lead distance instead (for legacy support).
Run instead of Walk (Run) <choices>
Should the NPC run instead of walk?
  • 1: No
  • 2: Yes
Retrieve player? (Retrieve) <choices>
Retrieve player?
  • 1: No, just idle and wait
  • 2: Yes, move to retrieve
Before Coming Back, Wait for Speech? (ComingBackWaitForSpeak) <choices>
Before Coming Back, Wait for Speech?
  • 1: No, come back while speaking
  • 2: Yes, wait for speech to finish
On Retrieve, Wait for Speech? (RetrieveWaitForSpeak) <choices>
On Retrieve, Wait for Speech?
  • 1: No, start leading while speaking
  • 2: Yes, wait for speech to finish
Speak start greeting? (DontSpeakStart) <choices>
On Retrieve, Wait for Speech?
  • 1: No, don`t speak the greeting
  • 2: Yes, speak the greeting
Leading during combat? (LeadDuringCombat) <choices>
Leading during combat?
  • 1: No. Stop to fight, resume leading when safe
  • 2: Yes, lead while fighting.
Gag leader? (GagLeader) <choices>
  • 1: No. Speak lead concepts normally, respecting other lead speech settings.
  • 2: Yes, don't speak any lead concepts at all, overriding all other lead speech settings.
Attract player concept modifier (AttractPlayerConceptModifier) <string>
Appended to the keyvalues passed into the response rules when the TLK_LEAD_ATTRACTPLAYER concept is spoken.
Player wait over concept modifier (WaitOverConceptModifier) <string>
Appended to the keyvalues passed into the response rules when the TLK_LEAD_WAITOVER concept is spoken.
Arrival concept modifier (ArrivalConceptModifier) <string>
Appended to the keyvalues passed into the response rules when the TLK_LEAD_ARRIVAL concept is spoken.
Post-arrival concept modifier (PostArrivalConceptModifier) <string>
Confirm:Seems to not be fully implemented?
Success concept modifier (SuccessConceptModifier) <string>
Appended to the keyvalues passed into the response rules when the TLK_LEAD_SUCCESS concept is spoken.
Failure concept modifier (FailureConceptModifier) <string>
Appended to the keyvalues passed into the response rules when the lead_fail concept is spoken.
Coming Back concept modifier (ComingBackConceptModifier) <string>
Appended to the keyvalues passed into the response rules when the TLK_LEAD_RETRIEVE concept is spoken. Spoken as the NPC starts returning to the player to retrieve them.
Retrieve concept modifier (RetrieveConceptModifier) <string>
Appended to the keyvalues passed into the response rules when the TLK_LEAD_COMINGBACK concept is spoken. Spoken when NPC has finally reached the player to retrieve them.


Search Type ([todo internal name (i)]) <choices>
How to search for the entities using the name specified in the actorname keyvalue. The Entity Name choice will make the engine search for a targetname of an entity, while the Classname choice will make it search for the name of an entity class (like npc_headcrab).
  • 0 : Entity Name
  • 1 : Classname

Flags

AI_LeadGoal:

  • 1: No def success
  • 2: No def failure
  • 4: Use goal facing
Todo: Clarify what these do?

Inputs

AI_LeadGoal:

SetSuccess
Notify success of leading. Not required, use only if the standard code for detecting success does not meet your needs or fails.
SetFailure
Notify failure of leading.
Note.pngNote:Not implemented.

Outputs

AI_LeadGoal:

OnArrival
Fired when NPC reaches the lead point. (Player may still be behind)
OnArrivalDone
Fired when NPC has played out any arrival speech.
OnSuccess
Fired when NPC achieves the goal.
OnFailure
Fired when NPC fails to achieve the goal.
OnDone
Fired when NPC completes behavior (any post-success or fail acting is complete).

See also

Retrieved from "https://developer.valvesoftware.com/w/index.php?title=Ai_goal_lead&oldid=216283"