HPL3/Amnesia: Rebirth/Tutorials/Ghouls - Revision history

Crater: added to patrol tutorial (patrol mode + example)

2020-11-15T07:25:55Z

added to patrol tutorial (patrol mode + example)

Darkfire: Patrol tutorial

2020-11-14T23:09:36Z

Patrol tutorial

Crater: clarified agent activation

2020-11-12T11:07:29Z

clarified agent activation

Crater: formatting #2

2020-11-11T11:21:58Z

formatting #2

Crater: formatting

2020-11-11T11:08:20Z

formatting

Crater: Created basic ghoul setup tutorial

2020-11-11T10:41:43Z

Created basic ghoul setup tutorial

New page

This tutorial will go over the basic setup required to use a ghoul agent. This tutorial assumes you have basic mapping and scripting knowledge.

== Map Setup ==

First, make sure any agents placed in your map are set to be inactive. This ensures that, when later activated in your map script, the agent is successfully added to AgentBlackboard.

The agent requires path nodes to move around, so make sure your map is populated with plenty of nodes. You can use the PathNodeGenerator area type to easily generate a large amount of nodes automatically (make sure whatever surfaces you want to generate nodes on are <i>inside</i> the area), but you may still want to place nodes manually in areas with difficult or precise navigation.

== Scripting Setup ==

If the required map prerequisites are fulfilled, your ghoul should be reactive to the player upon being activated in the map script.

To give the ghoul additional behavior, set up and switch the ghoul into the appropriate mode and issue commands as desired.

{{tip| More information on ghoul modes and commands can be found on the [[HPL3/Amnesia:_Rebirth/Scripting/Agents/Ghouls|Ghoul agent page]].}}

@@ Line 18: / Line 18: @@
 First, make sure there are PathNodes or PathNodePatrol nodes in the enemy area. They can be added with the Area tool.
 <syntaxhighlight lang="cpp">
 Ghoul_CommandPatrol_AddNode("ghoul", "PathNodePatrol_3", 3.0, 5.0);
 Ghoul_CommandPatrol_AddNode("ghoul", "PathNodePatrol_7", 3.0, 5.0);
@@ Line 28: / Line 29: @@
 Ghoul_CommandPatrol_Execute("ghoul", true, HowManyTimesToLoop, false, eGhoulSpeed_Walk, ""); //the parameters here can be changed of course
 </syntaxhighlight>
-{{warning| This won't work if you put it in OnEnter() or OnStart()! Use Setup() instead if you want the enemy to patrol when the map loads.}}
+To make the ghoul patrol indefinitely, use the patrol mode functions instead:

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

	{{tip\| More information on Ghoul modes and commands can be found on the [[HPL3/Amnesia:_Rebirth/Scripting/Agents/Ghouls\|Ghoul agent page]].}}		{{tip\| More information on Ghoul modes and commands can be found on the [[HPL3/Amnesia:_Rebirth/Scripting/Agents/Ghouls\|Ghoul agent page]].}}
		+
		+	== Adding a patrol path ==
		+
		+	First, make sure there are PathNodes or PathNodePatrol nodes in the enemy area. They can be added with the Area tool.
		+	To add a patrol path, use this code:
		+
		+	<syntaxhighlight lang="cpp">
		+	Ghoul_CommandPatrol_AddNode("ghoul", "PathNodePatrol_3", 3.0, 5.0);
		+	Ghoul_CommandPatrol_AddNode("ghoul", "PathNodePatrol_7", 3.0, 5.0);
		+	//Add more nodes as done above.
		+	//Keep in mind the AI can find a straight path between nodes by itself, so you only need to add nodes at junctions and sharp turns
		+	int HowManyTimesToLoop = 10;
		+	Ghoul_CommandPatrol_Execute("ghoul", true, HowManyTimesToLoop, false, eGhoulSpeed_Walk, ""); //the parameters here can be changed of course
		+	</syntaxhighlight>
		+
		+	{{warning\| This won't work if you put it in OnEnter() or OnStart()! Use Setup() instead if you want the enemy to patrol when the map loads.}}

@@ Line 9: / Line 9: @@
 == Scripting Setup ==
-If the required map prerequisites are fulfilled, your Ghoul should be reactive to the player upon being activated in the map script.
+If the required map prerequisites are fulfilled, your Ghoul should be reactive to the player upon being activated via <code>Entity_SetActive()</code> in the map script.
 To give the Ghoul additional behavior, set up and switch the Ghoul into the appropriate mode and issue commands as desired.
 {{tip| More information on Ghoul modes and commands can be found on the [[HPL3/Amnesia:_Rebirth/Scripting/Agents/Ghouls|Ghoul agent page]].}}

← Older revision		Revision as of 11:08, 11 November 2020
Line 1:		Line 1:
−	This tutorial will go over the basic setup required to use a ~~ghoul~~ agent. This tutorial assumes you have basic mapping and scripting knowledge.	+	This tutorial will go over the basic setup required to use a Ghoul agent. This tutorial assumes you have basic mapping and scripting knowledge.

	== Map Setup ==		== Map Setup ==