A First Look, Part 1 - Revision history

Silvematt: /* Quest Settings */

2022-02-14T23:10:22Z

Quest Settings

← Older revision		Revision as of 23:10, 14 February 2022
Line 27:		Line 27:
	Open the Quest "Every Dead Man's Nightmare" in the [[Quest\|Quest Editor]] and take a look at the content of the "Quests" tab.		Open the Quest "Every Dead Man's Nightmare" in the [[Quest\|Quest Editor]] and take a look at the content of the "Quests" tab.

	There are three important things that you should notice ~~are~~:		There are three important things that you should notice:

	* The ID of the Quest is "'''SQ_EveryDeadMansNightmare'''", so that is how we will reference to this quest.		* The ID of the Quest is "'''SQ_EveryDeadMansNightmare'''", so that is how we will reference to this quest.

Silvematt: /* Stage 20, Part I */

2022-02-14T19:59:17Z

Stage 20, Part I

← Older revision		Revision as of 19:59, 14 February 2022
Line 154:		Line 154:
	Notice that if you speak to Mother Nebivia again, the ''Condition Nodes'' will always return false, because the Current Quest Stage is 20, so it's greater than 10 and it doesn't match the conditions we've set anymore, neither it will ever do again.		Notice that if you speak to Mother Nebivia again, the ''Condition Nodes'' will always return false, because the Current Quest Stage is 20, so it's greater than 10 and it doesn't match the conditions we've set anymore, neither it will ever do again.

	== Stage 20~~, Part I~~ ==		== Stage 20 ==
	Open the Quest in the Quest Editor and take a look at the Stage 20. You'll notice that it has a [[Quest Stage Script]] assigned. The quest stage scripts works very similiar to the Item Script we'e analyzed before, the only difference is that it gets executed as soon as we reach the Stage its set to.		Open the Quest in the Quest Editor and take a look at the Stage 20. You'll notice that it has a [[Quest Stage Script]] assigned. The quest stage scripts works very similiar to the Item Script we'e analyzed before, the only difference is that it gets executed as soon as we reach the Stage its set to.

Silvematt: /* Stage 20, Part I */

2022-02-14T19:57:15Z

Stage 20, Part I

← Older revision		Revision as of 19:57, 14 February 2022
Line 203:		Line 203:
	If you made it through until here, congraturations, we've looked at a lot of things that are the cornerstone of the creation of your RPG game, you may take a small break now before going on. If you're confused and have a lot of unresolved questions, don't worry now, you just got started, give yourself some time, keep going with the tutorials and hopefully things will clarify as you progress.		If you made it through until here, congraturations, we've looked at a lot of things that are the cornerstone of the creation of your RPG game, you may take a small break now before going on. If you're confused and have a lot of unresolved questions, don't worry now, you just got started, give yourself some time, keep going with the tutorials and hopefully things will clarify as you progress.

	This tutorial continues with A First Look, Part 2.		This tutorial continues with [[A First Look, Part 2]].

Silvematt: /* Stage 20, Part II */

2022-02-14T19:56:54Z

Stage 20, Part II

← Older revision		Revision as of 19:56, 14 February 2022
Line 204:		Line 204:

	This tutorial continues with A First Look, Part 2.		This tutorial continues with A First Look, Part 2.

	~~== Stage 20, Part II ==~~
	~~We've left Part I while being in Stage 20, with the Thief approaching and forcing us to dialogue with him, and we've seen that this happened because of the Thief's [[Behaviour\|Behaviour.]]~~

	We are at the highlight of the quest, from now on the next stage will be determined by the Player's actions. This reveals the fact that Quest Stages are not always to be executed in order, some of them can be skipped or ignored, and you are free to set and branch you quests as you want.

	The conversation the Player will have with the Thief is the Current Dialogue the Thief has, and it is called "TheThiefOfTheDeadDefaultDialogue". To view it you can search it in the [[Rck Object Viewer]] or in the [[Rck AI Editor]] (Behaviour tab) while having "TheThiefOfTheDead001" selected.

	~~Open it up in the Node Editor and let's take a look.~~

	You should be able to get an idea on what happens, the Dialogue starts with the Entry Node that redirects to an ''NPC Dialogue Line'', the NPC speaks its line and then the player is prompted to say something (After Line = Player Questions).

	The quest branches from there, in base of what the player will pick the quest can end in three ways, as we've seen in the beginning of this article. We will analyze every possible outcome that will let the player complete the quest.

	~~=== 1. Stage 30 - Player Kills the Thief ===~~
	The Player can decide to kill the Thief by selecting the dialogue option "''[Attack] Your crimes are unforgivable''". Find the option in the Dialogue, and let's analyze what happens next. The end of the question is connected to a ''NPC Dialogue Line'' Node, so the Thief will speak a line "''This is not your grave, but you are welcome in it"''. What should happen next, is that the Thief will attack the player, and this is achived via [[Events And Consequences\|Events]] in the configuration of the node. Click on "Show/Hide" to reveal the hidden properties and settings, then open the Events.

	You will see that there is a [[Events And Consequences\|Consequence]] of type "RckAI Add In Faction" which pretty much explains itself, it allows to set an NPC to a determined [[Faction]]. The Consequence is configured to Add the NPC with ID "ThiefOfTheDead001" to the [[Faction]] with ID "AgainstPlayer".

	~~Setting an NPC to the "AgainstPlayer" Faction will make the NPC attack the Player at sight, which is exactly what we're looking for.~~

	The Dialogue continues with a special Node, which is the ''Dialogue AI Invoke'', this node allows you to call AI Functions from within the Dialogue, the AI that will be changed is obviously the AI that is talking to the Player. Just as we've changed the Behaviour the last time (going from ''DefaultBehaviour'' to ''FollowPlayer'') here we are switching Behavior again, this time to the EmptyStatePurpose that will make the NPC standing still. We want him to stand still because as soon as he detects the Player, he switch in Combat and will attack him, because we've set him in the "AgainstPlayer" Faction.

	~~The Dialogue ends with an ''End Node'', which has two Quest Updaters that lets the Player complete the Stage 20 and set the Current Quest Stage to 30.~~

	~~The Stage 30, if looked in the [[Quest\|Quest Editor]], doesn't have anything special but the description.~~

	~~So what happens now is that the Current Quest Stage is 30, the Player has as the current objective "Kill the looter", and the Thief NPC is attacking the Player.~~

	~~Perfect, now the last thing that we need is to update the quest when the Thief dies.~~

	~~To do that, we utilize the '''[[Quest Script]]''' we've seen in the Quest Editor.~~

	A [[Quest Script]] is very similiar to the [[Quest Stage Script]] we've seen and used before, but it has one big difference. A [[Quest Stage Script]] is designed to execute some lines of code and then get destroyed, while the '''Quest Script''' '''runs periodically while a quest is active'''.

	~~That means that throughout the whole mission, and still right now, every X seconds the Quest Script assigned to this quest was being executed.~~

	The Quest Scripts are useful in the occasion when you don't really know when something needs to happen, while with the case of the Quest Stage Scripts we always knew when something had to happen (we knew for example that the Thief had to spawn after speaking to Mother Nebivia).

	~~So a Quest Script is perfect for our case, since we don't really know at which time the Player will kill the Thief, or if he will at all.~~

	The script we're talking about is "EveryDeadMansNightmareQuestScript" and it is fundamentally very simple, altrough it is a little bit longer. If you've understood the previous Scripts, you shold have no problem getting this too, and once you got it, we're done.

	~~Open the script and let's analyze it.~~

	~~The first thing that you'll notice is that it utilizes four variables:<pre>~~
	~~bool doonce = false;~~
	~~bool doonce1 = false;~~
	~~bool doonce2 = false;~~

	~~RckAI thiefofthedead = null;~~
	~~</pre>"''doonce(1,2)"'' are booleans, they are used to ensure that some things only happen once, we will set those variables to true as soon as we execute the lines we want to be executed only once.~~

	~~"''thiefoftheidead''" instead, is a '''reference''' to the NPC. It let us access to every aspect of the NPC, in our case we will use it to check if the NPC died.~~

	~~Quest Scripts always have at least two functions:<pre>~~
	~~public void Start()~~
	~~</pre>And<pre>~~
	~~public override void CustomUpdate()~~
	~~</pre>Let's analyze both of them.~~

	The first one will allow you to set the value of the '''questScriptExecutionDelay''', which is the X amount of seconds that have to pass for the "CustomUpdate" function to be executed. Not only, the Start calls the function "RunQuestScript()" that will make the script run.<pre>
	~~public void Start()~~
	{
	~~quest.questScriptExecutionDelay = 1f; // CustomUpdate runs every 1 second.~~
	~~RunQuestScript(); // Starts the CustomUpdate~~
	}
	~~</pre>Let's take a look at the '''CustomUpdate()''':~~

	~~This may be a intimidating at first, but it's very simple as well. The first two lines:<pre>~~
	~~if (thiefofthedead == null)~~
	~~CellInformation.TryToGetAI("ThiefOfTheDead001", out thiefofthedead);~~
	</pre>Says: if the reference of the NPC is null, try to get it. The code will not go forward this point reference is found and set. The reference will be available to the Quest Script when the Thief NPC will be loaded in the scenes, at the next call of the CustomUpdate() the function "TryToGetAI" will finally get the reference. This is the standard way to get NPC references and it is used widely throughout the whole Demo.

	~~The "else" block runs only if the reference is set, for now ignore the first and last blocks and focus at the one at the center:<pre>~~
	~~else if(quest.currentQuestStage == 30 && !thiefofthedead.isAlive && !doonce1)~~
	{
	~~// Progress with quest~~
	~~RCKFunctions.CompleteQuestStage(quest.questID, 40);~~
	~~RCKFunctions.CompleteQuestStage(quest.questID, 30);~~

	~~doonce1 = true;~~
	}
	~~</pre>~~

Silvematt: Silvematt moved page A First Look to A First Look, Part 1

2022-02-14T19:56:24Z

Silvematt moved page A First Look to A First Look, Part 1

← Older revision	Revision as of 19:56, 14 February 2022
(No difference)

Silvematt: /* 1. Stage 30 - Player Kills the Thief */

2022-02-14T19:55:49Z

1. Stage 30 - Player Kills the Thief

← Older revision		Revision as of 19:55, 14 February 2022
Line 202:		Line 202:

	If you made it through until here, congraturations, we've looked at a lot of things that are the cornerstone of the creation of your RPG game, you may take a small break now before going on. If you're confused and have a lot of unresolved questions, don't worry now, you just got started, give yourself some time, keep going with the tutorials and hopefully things will clarify as you progress.		If you made it through until here, congraturations, we've looked at a lot of things that are the cornerstone of the creation of your RPG game, you may take a small break now before going on. If you're confused and have a lot of unresolved questions, don't worry now, you just got started, give yourself some time, keep going with the tutorials and hopefully things will clarify as you progress.

			This tutorial continues with A First Look, Part 2.

	== Stage 20, Part II ==		== Stage 20, Part II ==
	We've left Part I ~~of this stage~~ with the Thief approaching and forcing us to dialogue with him, and we've seen that this happened because of the Thief's [[Behaviour\|Behaviour.]]		We've left Part I while being in Stage 20, with the Thief approaching and forcing us to dialogue with him, and we've seen that this happened because of the Thief's [[Behaviour\|Behaviour.]]

	We are at the highlight of the quest, from now on the next stage will be determined by the Player's actions. This reveals the fact that Quest Stages are not always to be executed in order, some of them can be skipped or ignored, and you are free to set and branch you quests as you want.		We are at the highlight of the quest, from now on the next stage will be determined by the Player's actions. This reveals the fact that Quest Stages are not always to be executed in order, some of them can be skipped or ignored, and you are free to set and branch you quests as you want.
Line 268:		Line 270:
	quest.questScriptExecutionDelay = 1f; // CustomUpdate runs every 1 second.		quest.questScriptExecutionDelay = 1f; // CustomUpdate runs every 1 second.
	RunQuestScript(); // Starts the CustomUpdate		RunQuestScript(); // Starts the CustomUpdate
			}
			</pre>Let's take a look at the '''CustomUpdate()''':

			This may be a intimidating at first, but it's very simple as well. The first two lines:<pre>
			if (thiefofthedead == null)
			CellInformation.TryToGetAI("ThiefOfTheDead001", out thiefofthedead);
			</pre>Says: if the reference of the NPC is null, try to get it. The code will not go forward this point reference is found and set. The reference will be available to the Quest Script when the Thief NPC will be loaded in the scenes, at the next call of the CustomUpdate() the function "TryToGetAI" will finally get the reference. This is the standard way to get NPC references and it is used widely throughout the whole Demo.

			The "else" block runs only if the reference is set, for now ignore the first and last blocks and focus at the one at the center:<pre>
			else if(quest.currentQuestStage == 30 && !thiefofthedead.isAlive && !doonce1)
			{
			// Progress with quest
			RCKFunctions.CompleteQuestStage(quest.questID, 40);
			RCKFunctions.CompleteQuestStage(quest.questID, 30);

			doonce1 = true;
	}		}
	</pre>		</pre>

Silvematt: /* 1. Stage 30 - Player Kills the Thief */

2022-02-14T11:58:56Z

1. Stage 30 - Player Kills the Thief

@@ Line 31: / Line 31: @@
 * The ID of the Quest is "'''SQ_EveryDeadMansNightmare'''", so that is how we will reference to this quest.
 * The First Stage Is Default Stage, so when this quest is firstly added, the first stage in the list is the Stage that will be set as the Current Quest Stage.
-* The Quest uses a [[Quest Script]].
+* The Quest uses a [[Quest Script]] called "EveryDeadMansNightmareQuestScript".
@@ Line 242: / Line 242: @@
 So a Quest Script is perfect for our case, since we don't really know at which time the Player will kill the Thief, or if he will at all.

Silvematt: /* 1. Stage 30 - Player Kills the Thief */

2022-02-14T11:14:32Z

1. Stage 30 - Player Kills the Thief

@@ Line 1: / Line 1: @@
-In this tutorial we will deeply examine a quest from the Demo, which is "'''Every Dead Man's Nightmare'''", if you have not played this quest, do it before proceeding with the tutorial. This is a long article where most of the elements of the RCK are used and explained, or at least mentioned, so make sure you have plenty of time before going forward.
+In this tutorial we will deeply examine a quest from the Demo, which is "'''Every Dead Man's Nightmare'''", if you have not played this quest, do it before proceeding with the tutorial. This is a long article where most of the elements of the RCK are used and explained in depth, or at least mentioned, so make sure you have plenty of time before going forward.
 The Quest goes this way:
@@ Line 232: / Line 232: @@
 Perfect, now the last thing that we need is to update the quest when the Thief dies.

Silvematt: /* 1. Stage 30 - Player Kills the Thief */

2022-02-14T10:42:47Z

1. Stage 30 - Player Kills the Thief

← Older revision		Revision as of 10:42, 14 February 2022
Line 226:		Line 226:

	The Dialogue ends with an ''End Node'', which has two Quest Updaters that lets the Player complete the Stage 20 and set the Current Quest Stage to 30.		The Dialogue ends with an ''End Node'', which has two Quest Updaters that lets the Player complete the Stage 20 and set the Current Quest Stage to 30.

			The Stage 30, if looked in the [[Quest\|Quest Editor]], doesn't have anything special but the description.

			So what happens now is that the Current Quest Stage is 30, the Player has as the current objective "Kill the looter", and the Thief NPC is attacking the Player.

			Perfect, now the last thing that we need is to update the quest when the Thief dies.

Silvematt: /* Player Kills the Thief */

2022-02-14T10:34:50Z

Player Kills the Thief

← Older revision		Revision as of 10:34, 14 February 2022
Line 155:		Line 155:

	== Stage 20, Part I ==		== Stage 20, Part I ==
	~~We are at the highlight of the quest, from now on the next stage will be determined by the Player's actions.~~

	Open the Quest in the Quest Editor and take a look at the Stage 20. You'll notice that it has a [[Quest Stage Script]] assigned. The quest stage scripts works very similiar to the Item Script we'e analyzed before, the only difference is that it gets executed as soon as we reach the Stage its set to.		Open the Quest in the Quest Editor and take a look at the Stage 20. You'll notice that it has a [[Quest Stage Script]] assigned. The quest stage scripts works very similiar to the Item Script we'e analyzed before, the only difference is that it gets executed as soon as we reach the Stage its set to.

Line 206:		Line 204:

	== Stage 20, Part II ==		== Stage 20, Part II ==
	We've left Part I of this stage with the Thief approaching and forcing us to dialogue with him, and we've seen that this happened because of the Thief's [[Behaviour\|Behaviour.]]		We've left Part I of this stage with the Thief approaching and forcing us to dialogue with him, and we've seen that this happened because of the Thief's [[Behaviour\|Behaviour.]]

			We are at the highlight of the quest, from now on the next stage will be determined by the Player's actions. This reveals the fact that Quest Stages are not always to be executed in order, some of them can be skipped or ignored, and you are free to set and branch you quests as you want.

	The conversation the Player will have with the Thief is the Current Dialogue the Thief has, and it is called "TheThiefOfTheDeadDefaultDialogue". To view it you can search it in the [[Rck Object Viewer]] or in the [[Rck AI Editor]] (Behaviour tab) while having "TheThiefOfTheDead001" selected.		The conversation the Player will have with the Thief is the Current Dialogue the Thief has, and it is called "TheThiefOfTheDeadDefaultDialogue". To view it you can search it in the [[Rck Object Viewer]] or in the [[Rck AI Editor]] (Behaviour tab) while having "TheThiefOfTheDead001" selected.
Line 212:		Line 212:
	Open it up in the Node Editor and let's take a look.		Open it up in the Node Editor and let's take a look.

	You should be able to get an idea on what happens, the Dialogue starts, the NPC speaks its line and then the player is prompted to say something.		You should be able to get an idea on what happens, the Dialogue starts with the Entry Node that redirects to an ''NPC Dialogue Line'', the NPC speaks its line and then the player is prompted to say something (After Line = Player Questions).

	The quest branches from there, in base of what the player will pick the quest can end in three ways, as we've seen in the beginning of this article. We will analyze every possible outcome that will let the player complete the quest.		The quest branches from there, in base of what the player will pick the quest can end in three ways, as we've seen in the beginning of this article. We will analyze every possible outcome that will let the player complete the quest.

	=== Player Kills the Thief ===		=== 1. Stage 30 - Player Kills the Thief ===
			The Player can decide to kill the Thief by selecting the dialogue option "''[Attack] Your crimes are unforgivable''". Find the option in the Dialogue, and let's analyze what happens next. The end of the question is connected to a ''NPC Dialogue Line'' Node, so the Thief will speak a line "''This is not your grave, but you are welcome in it"''. What should happen next, is that the Thief will attack the player, and this is achived via [[Events And Consequences\|Events]] in the configuration of the node. Click on "Show/Hide" to reveal the hidden properties and settings, then open the Events.

			You will see that there is a [[Events And Consequences\|Consequence]] of type "RckAI Add In Faction" which pretty much explains itself, it allows to set an NPC to a determined [[Faction]]. The Consequence is configured to Add the NPC with ID "ThiefOfTheDead001" to the [[Faction]] with ID "AgainstPlayer".

			Setting an NPC to the "AgainstPlayer" Faction will make the NPC attack the Player at sight, which is exactly what we're looking for.

			The Dialogue continues with a special Node, which is the ''Dialogue AI Invoke'', this node allows you to call AI Functions from within the Dialogue, the AI that will be changed is obviously the AI that is talking to the Player. Just as we've changed the Behaviour the last time (going from ''DefaultBehaviour'' to ''FollowPlayer'') here we are switching Behavior again, this time to the EmptyStatePurpose that will make the NPC standing still. We want him to stand still because as soon as he detects the Player, he switch in Combat and will attack him, because we've set him in the "AgainstPlayer" Faction.

			The Dialogue ends with an ''End Node'', which has two Quest Updaters that lets the Player complete the Stage 20 and set the Current Quest Stage to 30.