Difference between revisions of "HPL3/Scripting/Scripting Guide/The Basics - Introduction"

From Frictional Wiki
Jump to navigation Jump to search
 
(9 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
{{note|'''Important:''' This guide only overviews the main features of HPL3's scripting capabilities '''on the concept level'''. It does not delve into the inner workings or into the full capabilities of the engine. You can read about a specific topic in more detail at the main scripting page of the game you are working with. Please see this guide as a springboard into HPL3 scripting.}}
+
{{note|'''Important:''' This guide only overviews the main and most commonly-used features of HPL3's scripting capabilities. It does not delve into the inner workings or into the full capabilities of the engine. You can read about a specific topic in more detail at the main scripting page of the game you are working with. Please see this guide as a springboard into HPL3 scripting.}}
−
 
 
 
{{shortPageTitle}}
 
{{shortPageTitle}}
 
{{Hpl3ScriptingGuideMenuBasic}}
 
{{Hpl3ScriptingGuideMenuBasic}}
Line 9: Line 8:
  
 
The guide is split into two sections: Basics and Advanced.
 
The guide is split into two sections: Basics and Advanced.
−
* The basic section touches on how to set up the tools necessary for scripting, the workflow of scripting in HPL3, how to script your maps.
+
 
−
* The advanced section touches on subjects beyond map scripting such as Modules and Ai.
+
*The basic section touches on how to set up the tools necessary for scripting and coverage of commonly-used features: The workflow of scripting in HPL3, how to script your maps, callbacks, timers, etc.
 +
*The advanced section touches on subjects beyond map scripting such as Modules and Ai.
  
 
'''Bear in mind that this tutorial mostly covers the most essential things you need to know in order to script your maps.'''
 
'''Bear in mind that this tutorial mostly covers the most essential things you need to know in order to script your maps.'''
  
−
==Prerequisites and Recommendations==
+
==Prerequisites==
−
 
+
There are a few necessary things you need to know before getting into this guide:
−
#The scripting language of HPL3 is called '''AngelScript''', which is similar to some of the more popular programming languages, so you should get familiar with the basic concepts of programming and be able to write simple code in the style of languages such as [https://en.wikipedia.org/wiki/Java_(programming_language) Java] or [https://en.wikipedia.org/wiki/C_Sharp_(programming_language) C#].
+
#The scripting language of HPL3 is called '''AngelScript''', which is similar to some of the more popular programming languages. If you have ''zero'' programming knowledge, you should start with the [[HPL3/Scripting/AngelScript_Fundamentals|AngelScript Fundamentals]] guide, and read '''<u>at least the first five chapters</u>.'''
−
#You should know how to create or edit a basic mod. See the [[HPL3/SOMA/Modding/Creating_a_Mod| Creating a Mod]] article for more information.
+
#You should know how to create or edit a basic mod for one of the HPL3 games:
−
{{note|If you have zero programming knowledge, you should start with the [[HPL3/Scripting/AngelScript_Fundamentals|AngelScript Fundamentals]] guide, and read '''at least the first five lessons.'''}}
+
#*[[HPL3/SOMA/Modding/Creating_a_Mod| Creating a Mod]] - SOMA
 +
#*[[HPL3/Amnesia: Rebirth/Modding/Creating_a_Mod| Creating a Mod]] - Amnesia: Rebirth
 
| style="width:0.1%" |
 
| style="width:0.1%" |
 
|}
 
|}

Latest revision as of 00:20, 15 August 2020

Note icon.png Important: This guide only overviews the main and most commonly-used features of HPL3's scripting capabilities. It does not delve into the inner workings or into the full capabilities of the engine. You can read about a specific topic in more detail at the main scripting page of the game you are working with. Please see this guide as a springboard into HPL3 scripting.

  1. The Basics - Introduction
  2. What is scripting in HPL3?
  3. Setting up CodeLite - Scripting Tool
  4. Scripting Workflow and Structure
  5. Hello World
  6. Calling Functions and Function Callbacks
  7. Helper Files
  8. The OnAction method
  9. The Update method
  10. Timers
  11. Sequences
  12. Local and Global Variables
  13. Enums
  14. Conclusion

Welcome to the scripting guide for the HPL3 Engine.

The guide is split into two sections: Basics and Advanced.

  • The basic section touches on how to set up the tools necessary for scripting and coverage of commonly-used features: The workflow of scripting in HPL3, how to script your maps, callbacks, timers, etc.
  • The advanced section touches on subjects beyond map scripting such as Modules and Ai.

Bear in mind that this tutorial mostly covers the most essential things you need to know in order to script your maps.

Prerequisites

There are a few necessary things you need to know before getting into this guide:

  1. The scripting language of HPL3 is called AngelScript, which is similar to some of the more popular programming languages. If you have zero programming knowledge, you should start with the AngelScript Fundamentals guide, and read at least the first five chapters.
  2. You should know how to create or edit a basic mod for one of the HPL3 games:
Retrieved from "https://wiki.frictionalgames.com/page?title=HPL3/Scripting/Scripting_Guide/The_Basics_-_Introduction&oldid=4354"