Frictional Game Wiki

<h1>Setting Up a Monster</h1> <div class="level1"> <p> To set up a monster in your custom story, you need to place it in the level editor. Monsters can be found when you click the "Entities" tab and then go to the subsection "enemy". For this tutorial, we'll choose the monster that is called "servant_grunt". Select it and then place it wherever you want. I'll assume you have a least part of your level constructed and know how to make a custom story entirely. Once you placed it, go to the select tool and select the monster you just placed. Under it's name, there will be a checkbox called "Active". Click the checkbox to set the monster inactive. You will notice that the monster is partially "faded" in a sense. We do this so that the monster doesn't exist from when you start the level. </p> <p> Now go to the tab called "Areas". The area type should say "Script". Click in the level editor on where you want the player to touch for when you want the monster to spawn. Go to the select tool and click on the area where it says "AREA". You will see that it's name is "ScriptArea_1". It is possible that it could be a different number at the end. Now click on where it says it's name and change it to "PlayerCollide" without quotes. Press enter. Then near the top right corner of the level editor you'll see that there are 3 buttons. From top to bottom they say "Translate", "Rotate", and "Scale". Click on the bottom one that says "Scale". Now scale the script area box to fit whatever hallway or path the player will touch to set the monster active. </p> </div> <h1>Adding Path Nodes</h1> <div class="level1"> <p> We will now add path nodes to the map so the monster walks from one place to another. When testing/playing your custom story, the monster will find you if you go too close to it. If the path nodes aren't near you, then the monster can't look for you over where you are, but for now we will have the monster walk from one place to another. </p> <p> Go click on the tab where it says "Areas" and then go to the subsection called "PathNode". Now make a path you want the monster to go to. Try not to put too many of them; Perhaps keep them a meter apart. Make sure the monster doesn't have to cut corners which could get him stuck. If you make him go up or down some stairs, make sure you put a path node on every step up or down. The monster will automatically disappear if it runs out of path nodes and the player isn't looking at it. </p> <p> Keep track of the last path node you put. If you click on the last one, that is how many path nodes you put. It's name should be "PathNodeArea_ " with the number of that path node is at the end. </p> </div> <h1>Scripting It All Together</h1> <div class="level1"> <p> Now you got the monster and path nodes set up. Now it's time to script. If the player collides with an area called "PlayerCollide", and, for this example, have ten path nodes with a monster called "servant_grunt_1", then we can create the script for our monster. </p> <pre class="code cpp"><span class="kw4">void</span> OnStart<span class="br0">(</span><span class="br0">)</span> <span class="br0">{</span> AddEntityCollideCallback<span class="br0">(</span>"Player", "PlayerCollide", "MonsterFunction", <span class="kw2">true</span>, <span class="nu0">1</span><span class="br0">)</span><span class="sy4">;</span> <span class="br0">}</span> <span class="kw4">void</span> MonsterFunction<span class="br0">(</span>string <span class="sy3">&</span>in asParent, string <span class="sy3">&</span>in asChild, <span class="kw4">int</span> alState<span class="br0">)</span> <span class="br0">{</span> SetEntityActive<span class="br0">(</span>"servant_grunt_1", <span class="kw2">true</span><span class="br0">)</span><span class="sy4">;</span> AddEnemyPatrolNode<span class="br0">(</span>"servant_grunt_1", "PathNodeArea_1", <span class="nu0">2</span>, ""<span class="br0">)</span><span class="sy4">;</span> AddEnemyPatrolNode<span class="br0">(</span>"servant_grunt_1", "PathNodeArea_2", <span class="nu0">0</span>, ""<span class="br0">)</span><span class="sy4">;</span> AddEnemyPatrolNode<span class="br0">(</span>"servant_grunt_1", "PathNodeArea_3", <span class="nu0">0</span>, ""<span class="br0">)</span><span class="sy4">;</span> AddEnemyPatrolNode<span class="br0">(</span>"servant_grunt_1", "PathNodeArea_4", <span class="nu0">0</span>, ""<span class="br0">)</span><span class="sy4">;</span> AddEnemyPatrolNode<span class="br0">(</span>"servant_grunt_1", "PathNodeArea_5", <span class="nu0">0</span>, ""<span class="br0">)</span><span class="sy4">;</span> AddEnemyPatrolNode<span class="br0">(</span>"servant_grunt_1", "PathNodeArea_6", <span class="nu0">0</span>, ""<span class="br0">)</span><span class="sy4">;</span> AddEnemyPatrolNode<span class="br0">(</span>"servant_grunt_1", "PathNodeArea_7", <span class="nu0">0</span>, ""<span class="br0">)</span><span class="sy4">;</span> AddEnemyPatrolNode<span class="br0">(</span>"servant_grunt_1", "PathNodeArea_8", <span class="nu0">0</span>, ""<span class="br0">)</span><span class="sy4">;</span> AddEnemyPatrolNode<span class="br0">(</span>"servant_grunt_1", "PathNodeArea_9", <span class="nu0">0</span>, ""<span class="br0">)</span><span class="sy4">;</span> AddEnemyPatrolNode<span class="br0">(</span>"servant_grunt_1", "PathNodeArea_10", <span class="nu0">4</span>, ""<span class="br0">)</span><span class="sy4">;</span> <span class="br0">}</span> </pre><p> </p> <p> Keep adding more "AddEnemyPatrolNode"s if there are more path nodes that you placed and then take away some "AddEnemyPatrolNode"s if there are less path nodes that you placed. In the Script Functions Page, this is what it says about the "AddEnemyPatrolNode" command: </p> <pre class="code c++"><span class="kw4">void</span> AddEnemyPatrolNode<span class="br0">(</span>string<span class="sy0">&</span> asName<span class="sy0">,</span> string<span class="sy0">&</span> asNodeName<span class="sy0">,</span> <span class="kw4">float</span> afWaitTime<span class="sy0">,</span> string<span class="sy0">&</span> asAnimation<span class="br0">)</span><span class="sy0">;</span> </pre><p> </p> <p> Adds a patrol node to the enemy's path. </p> <p> <em>asName </em>- internal name of the enemy<br/> <em>asNodeName </em>- path node<br/> <em>afWaitTime </em>- time in seconds that the enemy waits at the path node before continuing<br/> <em>asAnimation </em>- the animation the enemy uses when reaching the path node </p> </div> <h1>Loops</h1> <div class="level1"> <p> It is possible to make the monster to follow a set of patrol nodes and never stop repeating them until the monster is set disabled manually by "SetEntityActive("MonsterName", false);" With "MonsterName" being the name of the monster. Lets say, from the example above, that the monster follows those 10 path nodes, then reaches another 5 path nodes that he repeats until disabled. When the monster collides with the area "PNScriptArea", he will do the 5 path nodes in a loop The example below will include the "for" loop in which I discuss in another tutorial. Feel free to check it out. </p> <pre class="code cpp"><span class="kw4">void</span> OnStart<span class="br0">(</span><span class="br0">)</span> <span class="br0">{</span> AddEntityCollideCallback<span class="br0">(</span>"Player", "PlayerCollide", "MonsterFunction", <span class="kw2">true</span>, <span class="nu0">1</span><span class="br0">)</span><span class="sy4">;</span> AddEntityCollideCallback<span class="br0">(</span>"Player", "MonsterEnd", "MonsterEnd", <span class="kw2">true</span>, <span class="nu0">1</span><span class="br0">)</span><span class="sy4">;</span> AddEntityCollideCallback<span class="br0">(</span>"servant_grunt_1", "PNScriptArea", "MonsterFunction2", <span class="kw2">false</span>, <span class="nu0">1</span><span class="br0">)</span><span class="sy4">;</span> <span class="br0">}</span> <span class="kw4">void</span> MonsterFunction2<span class="br0">(</span><span class="br0">)</span> <span class="br0">{</span> <span class="kw1">for</span> <span class="br0">(</span><span class="kw4">int</span> i <span class="sy1">=</span> <span class="nu0">1</span><span class="sy4">;</span> i < 6<span class="sy4">;</span> i<span class="sy2">++</span><span class="br0">)</span> <span class="br0">{</span> AddEnemyPatrolNode<span class="br0">(</span>"servant_grunt_1", "PathNodeArea_"<span class="sy2">+</span>i, <span class="nu0">0</span>, ""<span class="br0">)</span><span class="sy4">;</span> <span class="br0">}</span> <span class="br0">}</span> <span class="kw4">void</span> MonsterFunction<span class="br0">(</span>string <span class="sy3">&</span>in asParent, string <span class="sy3">&</span>in asChild, <span class="kw4">int</span> alState<span class="br0">)</span> <span class="br0">{</span> SetEntityActive<span class="br0">(</span>"servant_grunt_1",<span class="kw2">true</span><span class="br0">)</span><span class="sy4">;</span> <span class="kw1">for</span> <span class="br0">(</span><span class="kw4">int</span> i <span class="sy1">=</span> <span class="nu0">1</span><span class="sy4">;</span> i < 11<span class="sy4">;</span> i<span class="sy2">++</span><span class="br0">)</span> <span class="br0">{</span> <span class="kw4">int</span> x <span class="sy1">=</span> i<span class="sy4">;</span> <span class="kw1">if</span> <span class="br0">(</span>i <span class="sy1">==</span> <span class="nu0">1</span><span class="br0">)</span> <span class="br0">{</span> x <span class="sy1">=</span> <span class="nu0">2</span><span class="sy4">;</span> <span class="br0">}</span> <span class="kw1">if</span> <span class="br0">(</span>i <span class="sy1">==</span> <span class="nu0">10</span><span class="br0">)</span> <span class="br0">{</span> x <span class="sy1">=</span> <span class="nu0">4</span><span class="sy4">;</span> <span class="br0">}</span> <span class="kw1">if</span> <span class="br0">(</span>i <span class="sy3">!</span><span class="sy1">=</span> <span class="nu0">1</span> <span class="sy3">||</span> i <span class="sy3">!</span><span class="sy1">=</span> <span class="nu0">10</span><span class="br0">)</span> <span class="br0">{</span> x <span class="sy1">=</span> <span class="nu0">0</span><span class="sy4">;</span> <span class="br0">}</span> AddEnemyPatrolNode<span class="br0">(</span>"servant_grunt_1", "PathNodeArea_"<span class="sy2">+</span>i, x, ""<span class="br0">)</span><span class="sy4">;</span> <span class="br0">}</span> <span class="br0">}</span> <span class="kw4">void</span> MosterEnd<span class="br0">(</span>string <span class="sy3">&</span>in asParent, string <span class="sy3">&</span>in asChild, <span class="kw4">int</span> alState<span class="br0">)</span> <span class="br0">{</span> SetEntityActive<span class="br0">(</span>"servant_grunt_1", <span class="kw2">false</span><span class="br0">)</span><span class="sy4">;</span> <span class="br0">}</span>     <span class="co1">//Tested 30th April 2012 and working correct.</span> </pre><p> </p> </div> <h1>Tips</h1> <div class="level1"> <p> Here is some tips and tricks that can help when trying to avoid disaster when it comes to monsters and path nodes. </p> <ol> <li class="level1"> A Monster can't follow the player too far away from their path that is designated to them or else they'll ignore you and continue on their path. Even the unscripted path nodes work.</li> <li class="level2"> Be careful when placing path nodes for a monster on stairs because if there is one that is missing or not placed right, it'll mess up completely.</li> <li class="level2"> The Script Function page is your friend! Under "Enemies", there are many things that can be used to "spice it up".</li> <li class="level2"> Any monster can bash through doors if their path nodes go through it and the box is unchecked for "DisableBreakable" for it.</li> <li class="level2"> You don't actually have to script the nodes, but it is recommended.</li> </ol> <p> <b>This wiki entry has been made by Kyle S. If you have any comments or need help with this, send me a private message on the Frictional Games Forum. (My name on there is Kyle)</b> </p> </div>