Frictional Game Wiki

<h1>CodeLite - How to get started</h1> <div class="level1"> <ol> <li class="level1"> <a href="/lib/exe/fetch.php?media=hpl3:3rdparty:codelite.zip" class="media mediafile mf_zip wikilink2" title="hpl3:3rdparty:codelite.zip">Download this zip file</a> as the current install on the offical website is out-of-date for Angel Script support.</li> <li class="level1 node"> Launch CodeLite and configure:<ul> <li class="level2"> Settings→Tags Settings→Display and Behavior: Increase number of items to display to 200.</li> <li class="level2"> Settings→Tags Settings→Display and Behavior: Activate "Keep function signature un-formated".</li> <li class="level2"> Settings→Tags Settings→ctags→Include Files: Add a path to "redist/script".</li> <li class="level2"> Settings→Tags Settings→ctags→Advanced: Add *.hps to file types list.</li> <li class="level2"> Settings→Tags Settings→Colouring: Increase maximum number of coloured symbols to at least 5000.</li> <li class="level2"> Settings→Tags Settings→Colouring: Enable colour local variables.</li> <li class="level2"> (optional) Settings→Tags Settings→Colouring: Enable colour workspace tags, also enable enumerator but leave the rest with default setting.</li> <li class="level2"> (optional) Settings→Tags Settings: Configure the rest to your liking. For example, auto-show & case sensitive enabled.</li> <li class="level2"> Settings→Syntax Highlighting and Fonts→Change Coloring Scheme to HPL3 if not already set.</li> </ul> </li> </ol> <ol> <li class="level1"> Create a new workspace.</li> <li class="level1 node"> Create a new project in the workspace. Use template Others → None-code project.<ul> <li class="level2"> Right-click on project folder, choose Import files from directory .. Import "redist/script/".</li> <li class="level2"> Right-click on project folder, choose Import files from directory .. Import "redist/maps/".</li> <li class="level2"> Right-click on project, New Virtual Folder, name it "_api".</li> <li class="level2"> Right-click on _api and Add An Existing File, add the file "redist/hps_api.hps" (might need to launch the game executable one time to have it created).</li> </ul> </li> </ol> <p> That should be it, .hps files should be color coded and parsed for completion as you added them to the project. If they did not, you can re-tag the workspace, project or the single file to see if it helps. If no color coding, it can be forced in View→View As: C++. </p> <ul> <li class="level1"> ctrl-space will bring up the completion drop down.</li> <li class="level1"> ctrl-shift-space will bring up hints when inside the () of a function.</li> <li class="level1"> ctrl-left-click on #include, variables, functions etc will open/move cursor to their location.</li> </ul> </div> <h2>Issues & Info</h2> <div class="level2"> <ul> <li class="level1"> Write Class@ object and not Class @object, the later will screw up coloring.</li> </ul> <ul> <li class="level1"> A bug currently can make some words loose coloring when you launch codelite. Open the Tags settings, click OK and the re-tag the file or project to fix it.</li> </ul> <ul> <li class="level1"> If you loose all coloring and can't get it back, delete the .tags file saved in the same folder as your workspace. Then relaunch codelite and re-tag workspace, save file to get it working.</li> </ul> <ul> <li class="level1"> Parameters with &in will break coloring of parameter, but will have no other side-effects.</li> </ul> </div> <h3>Extra Info</h3> <div class="level3"> <ol> <li class="level1 node"> Info about Settings→Syntax Highlighting and Fonts→Customize→Edit Lexer keyword sets, Set 0 to Set 4:<ul> <li class="level2"> Set 0 User configured list of keywords not already parsed. Can be edited.</li> <li class="level2"> Set 1 Unknown.</li> <li class="level2"> Set 2 Doxygen keywords, words here will be colored in comments using /** codeblocks when prepended with @ ie @var int myInt. Can be edited.</li> <li class="level2"> Set 3 Used for the setting "Colour workspace tags", automatically created (not visibly). Can NOT be edited.</li> <li class="level2"> Set 4 Used for the setting "Colour local variables", automatically created (not visibly). Can NOT be edited.</li> </ul> </li> </ol> </div>