HPL3/Amnesia: Rebirth/Scripting/Agents/Ghouls - Revision history

Crater: /* Modes vs Commands */ clarified command usage.

2020-11-16T03:12:35Z

Modes vs Commands: clarified command usage.

Crater: Added poorly documented functions :munshi_pain:

2020-11-16T02:58:00Z

Added poorly documented functions :munshi_pain:

Crater: fix typo + remove WIP notice

2020-11-16T02:19:50Z

fix typo + remove WIP notice

Crater: edited construction notice

2020-11-15T08:16:51Z

edited construction notice

Crater: Cleanup

2020-11-15T08:15:36Z

Cleanup

Crater: Added remaining ghoul functions

2020-11-15T08:13:00Z

Added remaining ghoul functions

Crater: minor error

2020-11-14T10:51:52Z

minor error

Crater: Added callback funcs.

2020-11-14T10:51:14Z

Added callback funcs.

Crater: cleaning up unused section

2020-11-14T09:37:35Z

cleaning up unused section

Crater: formatting 2

2020-11-14T09:31:50Z

formatting 2

@@ Line 8: / Line 8: @@
 Each mode contains a subset of behaviors. They define what the 'default' action for the agent should be and can be used to give different agents of the same type unique behaviors.
-A command is an order issued to the agent independent of the current mode. They can be used to override the agents current action.
+A command is an order issued to the agent independent of the current mode. They can be used to override the agents current action. The agent will resume any mode specific behavior after completing the command.
 Unlike previous HPL titles, agents should only be controlled through modes and commands,  NOT through changing the agent state.

@@ Line 21: / Line 21: @@
 {{CodeDocDetailParam|aMode|[[../../tString|tString]]|Which mode to put the ghoul in.}}
 {{CodeDocDetailParam|abForce|bool|If true the ghoul will switch the behavior instantly regardless of state, otherwise it will do so more naturally on the next best opportunity.}}
 {{CodeDocDetailReturn|void|}}
 {{CodeDocDetailBottom}}

@@ Line 1: / Line 1: @@
 {{ConstructionNotice| Basic overview of agent + improve page readability}}
@@ Line 114: / Line 112: @@
 {{CodeDocDetailTop|Ghoul_SetCanAttack}}
-<syntaxhighlight lang="c++">void Ghoul_SetAllowPlayerThrow(const tString &in asAgentName, bool abX)</syntaxhighlight>
+<syntaxhighlight lang="c++">void Ghoul_SetCanAttack(const tString &in asAgentName, bool abX)</syntaxhighlight>
 {{CodeDocDetailBody|Enables or disables the ghoul's attack.}}
 {{CodeDocDetailParamStart}}

← Older revision		Revision as of 08:16, 15 November 2020
Line 2:		Line 2:


−	{{ConstructionNotice\| Basic overview of agent}}	+	{{ConstructionNotice\| Basic overview of agent + improve page readability}}

	= Basic Overview =		= Basic Overview =

@@ Line 168: / Line 168: @@
 {{warning| It is unknown if the following functions are functional.}}
 {{CodeDocDetailTop|Ghoul_SetCanBeAttracted}}
@@ Line 191: / Line 200: @@
 This is the ghouls default mode. In this mode the ghoul will remain stationary when not reacting to the player.
 == eGhoulMode_Patrol ==
@@ Line 292: / Line 299: @@
 A ghoul in hunt mode will be always hunting the player.
 == eGhoulMode_StalkThroughHoles ==
@@ Line 310: / Line 315: @@
 {{CodeDocDetailReturn|void|}}
 {{CodeDocDetailBottom}}
 = Commands =
@@ Line 576: / Line 577: @@
 {{CodeDocDetailParam|asAgentName|[[../../tString|tString]]|Name of the agent.}}
 {{CodeDocDetailParam|asFunction|[[../../tString|tString]]|Name of the function, syntax: <code>void Func(const tString &in asEntity)</code>.}}
 {{CodeDocDetailReturn|void|}}
 {{CodeDocDetailBottom}}

@@ Line 155: / Line 155: @@
 TODO - Verify that this mode does nothing.
-= Command Functions =
+= Commands =
 == General ==
@@ Line 189: / Line 189: @@
 {{CodeDocDetailParam|abForce|bool|If the command should be executed immediately, or at a more appropriate time.}}
 {{CodeDocDetailParam|aSpeed|eGhoulSpeed|The speed with which the ghoul will move.}}
 {{CodeDocDetailParam|asCompletedCallback|[[../../tString|tString]]|The function that will be called after the command is completed, syntax: <code>void Func(const tString &in asEntity)</code>.}}
 {{CodeDocDetailReturn|void|}}
@@ Line 300: / Line 321: @@
 {{CodeDocDetailTop|Ghoul_CommandEmergeFromHole_Execute}}
 <syntaxhighlight lang="c++">void Ghoul_CommandEmergeFromHole_Execute(const tString &in asAgentName, const tString &in asHole, bool abForce = false, const tString &in asCompletedCallback = "", const tString &in asCustomAnim = "", const tString &in asCustomAnimEntity = "")</syntaxhighlight>
-{{CodeDocDetailBody|Executes the command that makes the ghoul emerge from a hole. If the ghoul is not hiding, it will be teleported to the hole and play the emerge animation..}}
+{{CodeDocDetailBody|Executes the command that makes the ghoul emerge from a hole. If the ghoul is not hiding, it will be teleported to the hole and play the emerge animation.}}
 {{CodeDocDetailParamStart}}
 {{CodeDocDetailParam|asAgentName|[[../../tString|tString]]|Name of the agent.}}
@@ Line 308: / Line 329: @@
 {{CodeDocDetailParam|asCustomAnim|[[../../tString|tString]]|Name of the custom animation.}}
 {{CodeDocDetailParam|asCustomAnimEntity|[[../../tString|tString]]|Entity to play the custom anim at.}}
 {{CodeDocDetailReturn|void|}}
 {{CodeDocDetailBottom}}

← Older revision		Revision as of 09:37, 14 November 2020
Line 5:		Line 5:

	= Basic Overview =		= Basic Overview =
−
−	~~== Map Configuration ==~~
−
−	~~Make sure any agents placed in your map are set to inactive. Activating them later via map script ensures that the agent can register itself with AgentBlackboard.~~
−
−	~~TODO~~
−
−	~~== Scripting Setup ==~~
−
−	~~TODO~~

	== Modes vs Commands ==		== Modes vs Commands ==

@@ Line 47: / Line 47: @@
 A ghoul in patrol mode will move to specified patrol path nodes when not reacting to the player.
 {{CodeDocDetailTop|Ghoul_ModePatrol_Setup}}
@@ Line 94: / Line 92: @@
 A ghoul in the random wander area will move to random nodes within a specified area when not reacting to the player.
 {{CodeDocDetailTop|Ghoul_ModeRandomWanderArea_Setup}}
@@ Line 112: / Line 108: @@
 TODO - Guard mode overview
 TODO - Guard vs Enthralled
 {{CodeDocDetailTop|Ghoul_ModeGuard_Setup}}
@@ Line 133: / Line 127: @@
 A ghoul in enthralled mode will move to a specified location when not reacting to the player.
 {{CodeDocDetailTop|Ghoul_ModeEnthralled_Setup}}
@@ Line 156: / Line 148: @@
 Mode behavior and functionality currently unknown.
 {{CodeDocDetailTop|Ghoul_ModeStalkThroughHoles_Setup}}