Frictional Game Wiki

<h1>Notepad++</h1> <div class="level1"> <p> <a href="http://notepad-plus.sourceforge.net" class="urlextern" title="http://notepad-plus.sourceforge.net" rel="nofollow">Notepad++</a> is a text editor with a ton of features useful when writing scripts for the HPL2 engine. Syntax colouring, auto-complete, call tips and so on and on. While it supports many different languages it does not, for obvious reasons, know much about our script functions. Here is a quick how-to for setting up Notepad++ so that it can auto-complete, give tips and give code snippets for .hps files. </p> </div> <h2>Notepad++ Setup</h2> <div class="level2"> <ol> <li class="level1"> Download <a href="http://sourceforge.net/projects/notepad-plus/files/" class="urlextern" title="http://sourceforge.net/projects/notepad-plus/files/" rel="nofollow">Notepad++</a></li> <li class="level1"> Settings menu - Preferences - File Association → customize add a .hps to registered exts</li> <li class="level1"> Settings menu - Preferences - Backup/AutoCompletion → Enable Function Completion and Function Parameters Hint on input.</li> <li class="level1"> Download <a href="/lib/exe/fetch.php?media=hpl2:third_party_tools:text:userdefinelang.zip" class="media mediafile mf_zip" title="hpl2:third_party_tools:text:userdefinelang.zip (842 B)">userdefinelang.zip</a>, unzip and in View menu → User-defined dialogue… Click import and import the file.</li> <li class="level1"> Download <a href="/lib/exe/fetch.php?media=hpl2:third_party_tools:text:hps.zip" class="media mediafile mf_zip" title="hpl2:third_party_tools:text:hps.zip (4.5 KB)">hps.zip</a>, unzip and go to Program Files\Notepad++\plugins\APIs and put hps.xml here.</li> </ol> </div> <h3>Notepad++ will now be able to</h3> <div class="level3"> <ul> <li class="level1"> .hps script files should have the text colourized properly when you open them.</li> <li class="level1"> Suggest functions, callbacks and other specific words when you begin to type, <b>pressing enter</b> completes the word. The suggestion window can be shown manually using <b>ctrl-space</b>.</li> <li class="level1"> When re-typing a custom word, say "bMyBool", pressing <b>ctrl-return</b> will suggest auto-completions for words found in the current .hps file you are editing.</li> <li class="level1"> Give a description of variables needed for functions and what type of variable it returns, if any. For example, type "AddTimer(" and it will show the variables needed. This can also be brought up if pressing <b>ctrl-shift-space</b> when in a function.</li> </ul> </div> <h2>QuickText</h2> <div class="level2"> <p> With this plugin you can extend functionality further. If you write a function then press <b>ctrl-shift-return</b> and it will auto-write a whole code snippet. </p> <ol> <li class="level1"> Using the Plugins menu in Notepad++, start Plugin Manager, in the available tab, select QuickText and install. Might have to <a href="http://sourceforge.net/tracker/download.php?group_id=183263&atid=904542&file_id=375790&aid=3009773" class="urlextern" title="http://sourceforge.net/tracker/download.php?group_id=183263&atid=904542&file_id=375790&aid=3009773" rel="nofollow">download manually</a> instead.</li> <li class="level1"> By default QuickText uses <b>ctrl-return</b>, this collides with a Notepad++ shortcut and does not work. Use Settings → Shortcut Mapper … → Plugin Commands and change this to <b>ctrl-shift-return</b>, on line 202.</li> <li class="level1"> Download <a href="/lib/exe/fetch.php?media=hpl2:third_party_tools:text:quicktext.zip" class="media mediafile mf_zip" title="hpl2:third_party_tools:text:quicktext.zip (3.2 KB)">quicktext.zip</a>, unzip and open in Notepad++, copy its content.</li> <li class="level1"> Open the file Notepad++/plugins/Config/QuickText.ini in Notepad++ and locate the row with [15], select it and paste the content from the previous step to replace and insert our HPL defined quicktext settings.</li> <li class="level1"> Close and start Notepad++ to activate it's functionality.</li> </ol> </div> <h3>With QuickText Notepad++ will now be able to</h3> <div class="level3"> <ul> <li class="level1"> Write a function name and press <b>ctrl-shift-return</b> and the rest of the function should auto-complete, for each following <b>ctrl-shift-return</b> you should move through the different places. For example type "for" then press <b>ctrl-shift-return</b>, it should do: </li> </ul> <pre class="code">for(X;X;X){ X } X </pre><p> </p> <p> <span class='np_break'> </span> Then for each <b>ctrl-shift-return</b> the cursor should jump to the X positions (they are not visible, only to show locations in example). There are also extra function auto-completes, for example add an s after for or if to make it a single line without the {}. </p> <p> That's it, code snippets and function lists can be extended further of course by the user if wanted! <b>Take note that QuickText can be a little buggy, for example the ctrl-shift-return to jump inside a function does not work reliable with all functions.</b> </p> </div>