Frictional Game Wiki

<h1>Script - Tutorial 1</h1> <div class="level1"> <p> HPL2 uses a script language called <a href="http://www.angelcode.com/angelscript/" class="urlextern" title="http://www.angelcode.com/angelscript/" rel="nofollow">AngelScript</a>, it is a C/C++ based syntax and a brief overview of the syntax can be <a href="http://www.angelcode.com/angelscript/sdk/docs/manual/doc_script.html" class="urlextern" title="http://www.angelcode.com/angelscript/sdk/docs/manual/doc_script.html" rel="nofollow">found here</a>. </p> </div> <h2>I do not know how to script?!</h2> <div class="level2"> <p> Scripting in HPL2 is about as easy as it gets, without adding an extra help system (for example Blizzard has some very nifty tools in their editors to help with scripting). But even so it will be a mess and you will be lost with no previous experience. What you need is basically an introduction course to C/C++ or a script language based on that syntax, for example Javascript. </p> <p> In my own experience, as a non-educated fellow in the world of scripting, I think you are best of taking a look at Javascript before you try to begin scripting in HPL2. Why? Because it is easy to find Javascript tutorials and information online and all you need is a text editor and your web browser. A place to start is for example w3schools <a href="http://www.w3schools.com/js/js_intro.asp" class="urlextern" title="http://www.w3schools.com/js/js_intro.asp" rel="nofollow">introduction to Javascript</a>. Mainly chapters <a href="http://www.w3schools.com/js/js_comments.asp" class="urlextern" title="http://www.w3schools.com/js/js_comments.asp" rel="nofollow">JS Comments</a> to <a href="http://www.w3schools.com/js/js_loop_for_in.asp" class="urlextern" title="http://www.w3schools.com/js/js_loop_for_in.asp" rel="nofollow">JS For...In</a> touch the general subjects that are common to all syntax's. </p> <p> A short version is that all that you do in HPL2 is to use functions, they are commands that you give properties and then all the magic is taken care of by the game. <a href="/doku.php?id=amnesia:script_functions" class="wikilink2" title="amnesia:script_functions" rel="nofollow">Everything here</a> are functions. You then decide how and when the functions are to be executed by using the common programing specific parts such as <em>statements</em>, <em>variables</em> and <em>comparisons</em> in combination with the objects you place using the <a href="/doku.php?id=tools:editors:level_editor:start" class="wikilink2" title="tools:editors:level_editor:start" rel="nofollow">level editor</a>. </p> </div> <h3>Example for those with no prior experience</h3> <div class="level3"> <p> Script is simplified and <b>will not actually work ingame AT ALL</b>, syntax is incorrect and only written as it is to give a short snippet of script code. </p> <pre class="code c">AddEntityCollideCallback<span class="br0">(</span>"Player"<span class="sy0">,</span>"AreaHelp"<span class="sy0">,</span>"CollidePlayerWithAreaHelp"<span class="br0">)</span><span class="sy0">;</span>   <span class="kw4">void</span> CollidePlayerWithAreaHelp<span class="br0">(</span><span class="br0">)</span> <span class="br0">{</span> <span class="kw1">if</span><span class="br0">(</span>HasItem<span class="br0">(</span>"cellar_key"<span class="br0">)</span> <span class="sy0">==</span> <span class="kw2">true</span><span class="br0">)</span> <span class="br0">{</span> SetMessage<span class="br0">(</span>"Use your inventory to select key and use on door."<span class="sy0">,</span> <span class="nu0">10</span><span class="br0">)</span><span class="sy0">;</span> <span class="br0">}</span> <span class="kw1">else</span> <span class="br0">{</span> SetMessage<span class="br0">(</span>"You will need a key to open the door."<span class="sy0">,</span> <span class="nu0">5</span><span class="br0">)</span><span class="sy0">;</span> <span class="br0">}</span>   <span class="br0">}</span> </pre><p> </p> <p> <span class='np_break'> </span> Imagine that, using the level editor, we have created a simple room. In this room we have a locked door and in front of that door we have added an area called "AreaHelp". What we now have done in the script is that we have added a callback (a trigger if you so like), this is the line with AddEntityCollideCallback. It says that when the Player enters AreaHelp it should trigger the function CollidePlayerWithAreaHelp. </p> <p> - When the player enters this area the function (begins with void CollidePlayerWithAreaHelp() and the rest of the script) is triggered and this occurs: </p> <ol> <li class="level1 node"> It asks, does the player have the item "cellar_key" in his inventory? <ol> <li class="level2"> If this is true, we will then show a message on the screen for 10 seconds telling him what to do with the key.</li> <li class="level2"> If this is not true, we show a message about where to find the key for 5 seconds instead.</li> </ol> </li> </ol> <p> This is all there is to it. Sure things will be more complicated and much longer, but the whole idea is always the same. When something occurs that you are looking for, you ask if something is the way you want it to, depending on what the answer is, you do different things. The tricky part will be to learn all the specific bits that you can do, what the game allows for, how to write something that affects many objects, but without doing it specifically for each (this is where variables comes in) and that sort of thing (always being logical is the key, but that is hard for a human (me)!). Imaging it as being a Swede and learning English: </p> <p> You learn that "Flytta" can be "Move" in English, that you can <em>Move</em> an object, say a <em>Rock</em>, and that the <em>Rock</em> can be <em>Moved</em> at different <em>Speeds</em>. In HPL2 this would be a function you can call in the script, for example (again this does not really work): </p> <pre class="code c">MoveObject<span class="br0">(</span>"Rock"<span class="sy0">,</span> <span class="nu0">10</span><span class="br0">)</span><span class="sy0">;</span> </pre><p> </p> <p> <span class='np_break'> </span> How this actually makes the rock move is not important, that is all taken care of by the game, but you have specified that you want to move a specific Rock and that is should be moved at a speed of 10 (this could be 10 m/s, but this is something you need to look up and learn and not something you specify). The only HPL2 specific thing here would be <em>MoveObject</em>, which is the name of our function (word) and the <em>(_ckgedit_QUOT<u>ckgedit>,);<em> are the grammar (the syntax for C/C++ like scripts) and </em>Rock<em> is a name of an object in the level editor and </em>10<em> is a specified value. Good luck and remember to read and learn ALL <a href="/doku.php?id=amnesia:script_functions" class="wikilink2" title="amnesia:script_functions" rel="nofollow">script functions</a> available, or just bookmark that page. ;) ===== Scripting with HPL2 ===== A script file is a plain text file, with the same name as your map file. For example: my_test_level.map should have a my_test_level.hps text file in the same location. A script file can be edited using good old Notepad, if you do a lot of scripting it might be a good thing to <a href="/doku.php?id=third_party_tools:text:notepad" class="wikilink2" title="third_party_tools:text:notepad" rel="nofollow">read about Notepad++</a>. For the below to work you need a very simple test map. All you need is to make a plane to stand on, a PlayerStartArea to have a place the player will start at and a light so that you can see. In the last example you will need to add a Script Area too and naming it "AreaTest01". See <a href="/doku.php?id=tutorials:level_editor:tutorial_1" class="wikilink2" title="tutorials:level_editor:tutorial_1" rel="nofollow">this tutorial</a> for map creation. - The script file is quite straightforward, begin by copying and pasting the first example below into your text file. Then start the game with your map and you should be able to activate a lantern, if you look in the inventory you should also have 10 tinderboxes. If you do not, make sure that you have setup a <a href="/doku.php?id=amnesia:devenvguide" class="wikilink2" title="amnesia:devenvguide" rel="nofollow">development environment</a>, failing to do this will make all debug stuff not work. - In the second example there are two new things: A AddTimer in OnStart and a new function. - In the third example, an AddEntityCollideCallback was added in OnStart and a new function for it. You also add an area to your level and call it "AreaTest01", placing it close to the PlayerStartArea. ==== A default .hps file ==== <code c> </em><em></em><em></em><em></em><em></em><em></em><em></em> Run first time starting map void OnStart() { <em>Add the Lantern and 10 Tinderboxes when in Debug mode, always good to have light! if(ScriptDebugOn()) { GiveItemFromFile(<u>GESHI_QUOT</u>lantern<u>GESHI_QUOT</u>, <u>GESHI_QUOT</u>lantern.ent<u>GESHI_QUOT</u>); for(int i=0;i<u>GESHI_OPEN</u>10;i++) GiveItemFromFile(<u>GESHI_QUOT</u>tinderbox<u>_GESHI_QUOT</u>+i, <u>GESHI_QUOT</u>tinderbox.ent<u>GESHI_QUOT</u>); } } </em><em></em><em></em><em></em><em></em><em></em><em></em> Run when entering map void OnEnter() { } <em></em><em></em><em></em><em></em><em></em><em></em><em></em> <em> Run when leaving map void OnLeave() { } </code> <span class='np_break'> </span> ==== Adding a timer function ==== In OnStart we now add: <code c> AddTimer(<u>GESHI_QUOT</u>tut01<u>GESHI_QUOT</u>, 5, <u>GESHI_QUOT</u>TimerTutorial01<u>GESHI_QUOT</u>); </code> <span class='np_break'> </span> Then anywhere in the script file, as long as it is NOT inside OnStart, OnBegin or OnLeave, we add: <code c> void TimerTutorial01(string &in asTimer) { SetMessage(<u>GESHI_QUOT</u>Inventory<u>GESHI_QUOT</u>, <u>GESHI_QUOT</u>CombineLevel12Error<u>GESHI_QUOT</u>, 0); } </code> <span class='np_break'> </span> Making the whole script file look like this (with comments added to explain what is going on): <code c> </em>The Timer function that triggers after 5 second from first time map loads. void TimerTutorial01(string &in asTimer) { <em>Displays a message on screen. Category and Entry are the two strings, as read from the file </em>redist/config/lang_main/english.lang (if using English). <em>0 is the time it will be shown (0 means it auto-calculates the time based on length of message). SetMessage(<u>GESHI_QUOT</u>Inventory<u>GESHI_QUOT</u>, <u>GESHI_QUOT</u>CombineLevel12Error<u>GESHI_QUOT</u>, 0); } </em><em></em><em></em><em></em><em></em><em></em><em></em> Run first time starting map void OnStart() { <em>A timer named tut01, that triggers after 5 second the function TimerTutorial01 AddTimer(<u>GESHI_QUOT</u>tut01<u>GESHI_QUOT</u>, 5, <u>GESHI_QUOT</u>TimerTutorial01<u>GESHI_QUOT</u>); </em>Add the Lantern and 10 Tinderboxes when in Debug mode, always good to have light! if(ScriptDebugOn()) { GiveItemFromFile(</u>GESHI_QUOT<u>lantern</u>GESHI_QUOT<u>, </u>GESHI_QUOT<u>lantern.ent</u>GESHI_QUOT<u>); for(int i=0;i</u>GESHI_OPEN<u>10;i++) GiveItemFromFile(</u>GESHI_QUOT<u>tinderbox</u>_GESHI_QUOT<u>+i, </u>GESHI_QUOT<u>tinderbox.ent</u>GESHI_QUOT<u>); } } <em></em><em></em><em></em><em></em><em></em><em></em><em></em> <em> Run when entering map void OnEnter() { } </em><em></em><em></em><em></em><em></em><em></em><em></em> Run when leaving map void OnLeave() { } </code> <span class='np_break'> </span> ==== Adding a collide function ==== In OnStart we now add: <code c> AddEntityCollideCallback(</u>GESHI_QUOT<u>Player</u>GESHI_QUOT<u>, </u>GESHI_QUOT<u>AreaTest01</u>GESHI_QUOT<u>, </u>GESHI_QUOT<u>CollideAreaTest01</u>GESHI_QUOT<u>, true, 1); </code> <span class='np_break'> </span> Then anywhere in the script file, as long as it is NOT inside OnStart, OnBegin, OnLeave or TimerTutorial01, we add: <code c> void CollideAreaTest01(string &in asParent, string &in asChild, int alState) { RemoveTimer(</u>GESHI_QUOT<u>tut01</u>GESHI_QUOT<u>); AddDebugMessage(</u>GESHI_QUOT<u>Entered area!</u>GESHI_QUOT<u>, false); } </code> <span class='np_break'> </span> Making the whole script file look like this (with comments added to explain what is going on): <code c> <em>The Timer function that triggers after 5 second from first time map loads. void TimerTutorial01(string &in asTimer) { </em>Displays a message on screen. Category and Entry are the two strings, as read from the file <em>redist/config/lang_main/english.lang (if using English). </em>0 is the time it will be shown (0 means it auto-calculates the time based on length of message). SetMessage(</u>GESHI_QUOT<u>Inventory</u>GESHI_QUOT<u>, </u>GESHI_QUOT<u>CombineLevel12Error</u>GESHI_QUOT<u>, 0); } <em>The collision function that triggers when player enters area AreaTest01 void CollideAreaTest01(string &in asParent, string &in asChild, int alState) { </em>Removing the timer tut01, so if player trigger this function before 5 seconds has passed since map <em>was loaded, the function TimerTutorial01 will not occur. RemoveTimer(<u>GESHI_QUOT</u>tut01<u>GESHI_QUOT</u>); </em>A message that is only displayed when in debug mode. AddDebugMessage(</u>GESHI_QUOT<u>Entered area!</u>GESHI_QUOT<u>, false); } <em></em><em></em><em></em><em></em><em></em><em></em><em></em> <em> Run first time starting map void OnStart() { </em>A timer named tut01, that triggers after 5 second the function TimerTutorial01 AddTimer(</u>GESHI_QUOT<u>tut01</u>GESHI_QUOT<u>, 5, </u>GESHI_QUOT<u>TimerTutorial01</u>GESHI_QUOT<u>); <em>If the player enters an area named <u>GESHI_QUOT</u>AreaTest01<u>GESHI_QUOT</u>, the function CollideAreaTest01 will trigger. </em>true, means this will only happen 1 time, set to false to happen every time the player collides <em>with the area. </em>1 means only when player enter area, -1 would be when leaving area and 0 would be both. AddEntityCollideCallback(</u>GESHI_QUOT<u>Player</u>GESHI_QUOT<u>, </u>GESHI_QUOT<u>AreaTest01</u>GESHI_QUOT<u>, </u>GESHI_QUOT<u>CollideAreaTest01</u>GESHI_QUOT<u>, true, 1); <em>Add the Lantern and 10 Tinderboxes when in Debug mode, always good to have light! if(ScriptDebugOn()) { GiveItemFromFile(<u>GESHI_QUOT</u>lantern<u>GESHI_QUOT</u>, <u>GESHI_QUOT</u>lantern.ent<u>GESHI_QUOT</u>); for(int i=0;i<u>GESHI_OPEN</u>10;i++) GiveItemFromFile(<u>GESHI_QUOT</u>tinderbox<u>_GESHI_QUOT</u>+i, <u>GESHI_QUOT</u>tinderbox.ent<u>GESHI_QUOT</u>); } } </em><em></em><em></em><em></em><em></em><em></em><em></em> Run when entering map void OnEnter() { } <em></em><em></em><em></em><em></em><em></em><em></em><em></em> <em> Run when leaving map void OnLeave() { } </code> </p> </div>