Difference between revisions of "HPL3/SOMA/Scripting"

From Frictional Wiki
< HPL3‎ | SOMA
Jump to navigation Jump to search
 
(32 intermediate revisions by the same user not shown)
Line 1: Line 1:
 +
{{constructionNotice|This category and its sub-pages are undergoing major editing, as some information in this category and all the sub pages is currently in the process of being formatted or re-written from scratch to achieve a higher standard of formatting, or not everything is yet available. More pages and information will gradually be added.}}
 +
 +
'''This category deals with Scripting and Programming in HPL3 and SOMA. Everything regarding map scripting, gameplay programming and low-level engine topics are covered here.'''
 +
 
{{CategoryHeader}}
 
{{CategoryHeader}}
 
{{CategoryNewcolumn}}
 
{{CategoryNewcolumn}}
Line 6: Line 10:
  
 
== Getting Started ==
 
== Getting Started ==
* [[HPL3/Scripting/HPL3 Scripting Guide|Scripting Guide]]
+
* [[HPL3/Scripting/HPL3 Scripting Guide|HPL3 Scripting Guide]]
* [[HPL3/Scripting/AngelScript Fundamentals|AngelScript Fundamentals]]
+
* [[HPL3/Scripting/AngelScript Fundamentals|AngelScript Fundamentals Guide]]
 +
----
 +
* [[HPL3/Scripting/Level Scripting - Best Practices|Level Scripting - Best Practices]]
 +
* [[HPL3/Scripting/Scripting Conventions|Scripting Conventions]]
  
 
== General ==
 
== General ==
* [[HPL3/Scripting/Scripting Conventions|Scripting Conventions]]
+
*'''[[HPL3/SOMA/Scripting/Scripting Api|Scripting Function Reference Api]]'''
* [[HPL3/Scripting/Level Scripting - Best Practices|Level Scripting - Best Practices]]
+
* [[HPL3/Scripting/Props|Props]]
* [[HPL3/Scripting/Scripting Api|Scripting Api]]
+
* [[HPL3/Scripting/Areas|Areas]]
* [[HPL3/Scripting/Custom Depth|Custom Depth]]
+
* [[HPL3/Scripting/Level Streaming|Level Streaming]]
 +
* [[HPL3/Scripting/Entity Components|Entity Components]]
 +
* [[HPL3/Scripting/ID Handles|ID Handles]]
  
 
== Helpers ==
 
== Helpers ==
* [[HPL3/Scripting/Helpers Overview|Helper Files Overview]]
+
<table>
* [[HPL3/Scripting/Ai Helper|Game Helper]]
+
<tr style="vertical-align:top">
* [[HPL3/Scripting/Ai Helper|Map Helper]]
+
<td>
* [[HPL3/Scripting/Ai Helper|Player Helper]]
+
* [[HPL3/SOMA/Scripting/Game Helper|Game Helper]]
* [[HPL3/Scripting/Ai Helper|Ai Helper]]
+
* [[HPL3/SOMA/Scripting/Map Helper|Map Helper]]
* [[HPL3/Scripting/Ai Helper|Areas Helper]]
+
* [[HPL3/SOMA/Scripting/Player Helper|Player Helper]]
* [[HPL3/Scripting/Ai Helper|Audio Helper]]
+
* [[HPL3/SOMA/Scripting/Audio Helper|Audio Helper]]
* [[HPL3/Scripting/Ai Helper|Effects Helper]]
+
* [[HPL3/SOMA/Scripting/Effects Helper|Effects Helper]]
* [[HPL3/Scripting/Ai Helper|EventDB Helper]]
+
* [[HPL3/SOMA/Scripting/Areas Helper|Areas Helper]]
* [[HPL3/Scripting/Ai Helper|Geneal Helper]]
+
* [[HPL3/SOMA/Scripting/Ai Helper|Ai Helper]]
* [[HPL3/Scripting/Ai Helper|ImGui Helper]]
+
</td>
* [[HPL3/Scripting/Ai Helper|Modules Helper]]
+
<td>
* [[HPL3/Scripting/Ai Helper|Physics Helper]]
+
* [[HPL3/SOMA/Scripting/Modules Helper|Modules Helper]]
* [[HPL3/Scripting/Ai Helper|Props Helper]]
+
* [[HPL3/SOMA/Scripting/Physics Helper|Physics Helper]]
* [[HPL3/Scripting/Ai Helper|Sequences Helper]]
+
* [[HPL3/SOMA/Scripting/Props Helper|Props Helper]]
 +
* [[HPL3/SOMA/Scripting/Sequences Helper|Sequences Helper]]
 +
* [[HPL3/SOMA/Scripting/Geneal Helper|Geneal Helper]]
 +
* [[HPL3/SOMA/Scripting/ImGui Helper|ImGui Helper]]
 +
* [[HPL3/SOMA/Scripting/EventDB Helper|EventDB Helper]]
 +
</td>
 +
</tr>
 +
</table>
  
 
== User Modules ==
 
== User Modules ==
Line 38: Line 54:
 
=== General ===
 
=== General ===
 
* [[HPL3/SOMA/Scripting/Menu Handler|Menu Handler]]
 
* [[HPL3/SOMA/Scripting/Menu Handler|Menu Handler]]
* [[HPL3/Scripting/SOMA/Eye Tracking Handler|Eye Tracking Handler]]
+
* [[HPL3/SOMA/Scripting/Eye Tracking Handler|Eye Tracking Handler]]
* [[HPL3/Scripting/SOMA/Game Over Handler|Game Over Handler]]
+
* [[HPL3/SOMA/Scripting/Game Over Handler|Game Over Handler]]
* [[HPL3/Scripting/SOMA/Hint Handler|Hint Handler]]
+
* [[HPL3/SOMA/Scripting/Hint Handler|Hint Handler]]
 
* [[HPL3/Scripting/Credits Overview|Credits Handler]]
 
* [[HPL3/Scripting/Credits Overview|Credits Handler]]
  
 
=== Player ===
 
=== Player ===
* [[HPL3/Scripting/SOMA/User Modules Overview|Player Energy Handler]]
+
* [[HPL3/SOMA/Scripting/Player Energy Handler|Player Energy Handler]]
* [[HPL3/Scripting/SOMA/User Modules Overview|Player Hands Handler]]
+
* [[HPL3/SOMA/Scripting/Player Hands Handler|Player Hands Handler]]
* [[HPL3/Scripting/SOMA/User Modules Overview|Player Pickup Handler]]
+
* [[HPL3/SOMA/Scripting/Player Pickup Handler|Player Pickup Handler]]
* [[HPL3/Scripting/SOMA/User Modules Overview|Player Tool Handler]]
+
* [[HPL3/SOMA/Scripting/Player Tool Handler|Player Tool Handler]]
  
 
=== Gameplay ===
 
=== Gameplay ===
* [[HPL3/Scripting/SOMA/User Modules Overview|Attack Meter Handler]]
+
* [[HPL3/SOMA/Scripting/Attack Meter Handler|Attack Meter Handler]]
* [[HPL3/Scripting/SOMA/User Modules Overview|Datamine Handler]]
+
* [[HPL3/SOMA/Scripting/Datamine Handler|Datamine Handler]]
* [[HPL3/Scripting/SOMA/User Modules Overview|Infection Handler]]
+
* [[HPL3/SOMA/Scripting/Infection Handler|Infection Handler]]
* [[HPL3/Scripting/SOMA/User Modules Overview|Inventory Handler]]
+
* [[HPL3/SOMA/Scripting/Inventory Handler|Inventory Handler]]
  
 
=== Effects ===
 
=== Effects ===
* [[HPL3/Scripting/SOMA/User Modules Overview|Distortion Effect Handler]]
+
* [[HPL3/SOMA/Scripting/Distortion Effect Handler|Distortion Effect Handler]]
* [[HPL3/Scripting/SOMA/User Modules Overview|Wake Handler]]
+
* [[HPL3/SOMA/Scripting/Wake Handler|Wake Handler]]
* [[HPL3/Scripting/SOMA/User Modules Overview|Description Handler]]
+
* [[HPL3/SOMA/Scripting/Description Handler|Description Handler]]
* [[HPL3/Scripting/SOMA/User Modules Overview|Map Effects Handler]]
+
* [[HPL3/SOMA/Scripting/Map Effects Handler|Map Effects Handler]]
* [[HPL3/Scripting/SOMA/User Modules Overview|Light Flash Handler]]
+
* [[HPL3/SOMA/Scripting/Light Flash Handler|Light Flash Handler]]
* [[HPL3/Scripting/SOMA/User Modules Overview|Emotion Handler]]
+
* [[HPL3/SOMA/Scripting/Emotion Handler|Emotion Handler]]
* [[HPL3/Scripting/SOMA/User Modules Overview|Highlight Effect Handler]]
+
* [[HPL3/SOMA/Scripting/Highlight Effect Handler|Highlight Effect Handler]]
* [[HPL3/Scripting/SOMA/User Modules Overview|Terrain Particle Handler]]
+
* [[HPL3/SOMA/Scripting/Terrain Particle Handler|Terrain Particle Handler]]
  
 
{{CategoryNewcolumn}}
 
{{CategoryNewcolumn}}
Line 71: Line 87:
  
 
== GUI ==
 
== GUI ==
* [[HPL3/Gui Overview|Gui Overview]]
+
* [[HPL3/Gui|Gui Overview]]
 
* [[HPL3/SOMA/Scripting/Terminals Overview|Making Terminals]]
 
* [[HPL3/SOMA/Scripting/Terminals Overview|Making Terminals]]
  
 
== NPCs ==
 
== NPCs ==
* [[HPL3/NPCs Overview|NPCs Overview]]
+
* [[HPL3/NPCs|NPCs Overview]]
* [[HPL3/Agents Overview|Agents Overview]]
+
* [[HPL3/Agents|Agents Overview]]
* [[HPL3/Agents Critter|Critter Overview]]
+
* [[HPL3/Critter|Critter Overview]]
  
 
== Player ==
 
== Player ==
 
* [[HPL3/Player Overview|Player Overview]]
 
* [[HPL3/Player Overview|Player Overview]]
* [[HPL3/Player States|Player States]]
+
* [[HPL3/SOMA/Scripting/Player States|Player States]]
  
 
== Effects ==
 
== Effects ==
 
* [[HPL3/Scripting/Effects Overview|Effects Overview]]
 
* [[HPL3/Scripting/Effects Overview|Effects Overview]]
* [[HPL3/Scripting/Chromatic Aberration|Effects Interfaces]]
+
* [[HPL3/Scripting/Effects Interfaces|Effects Interfaces]]
 
* [[HPL3/Scripting/Depth of Field|Depth of Field]]
 
* [[HPL3/Scripting/Depth of Field|Depth of Field]]
* [[HPL3/Scripting/Chromatic Aberration|Flash]]
+
* [[HPL3/Scripting/Radial Blur|Radial Blur]]
* [[HPL3/Scripting/Chromatic Aberration|Gamepad]]
+
* [[HPL3/Scripting/Screen|Screen]]
* [[HPL3/Scripting/Chromatic Aberration|ImageFadeFx]]
+
* [[HPL3/Scripting/Shake|Shake]]
* [[HPL3/Scripting/Chromatic Aberration|Image Trail]]
+
* [[HPL3/Scripting/Sway|Sway]]
* [[HPL3/Scripting/Chromatic Aberration|Lens Distortion]]
+
* [[HPL3/Scripting/Tone Mapping|Tone Mapping]]
* [[HPL3/Scripting/Chromatic Aberration|Radial Blur]]
+
* [[HPL3/Scripting/ImageFadeFx|ImageFadeFx]]
* [[HPL3/Scripting/Chromatic Aberration|Screen]]
+
* [[HPL3/Scripting/Image Trail|Image Trail]]
* [[HPL3/Scripting/Chromatic Aberration|Shake]]
+
* [[HPL3/SOMA/Scripting/Time Glitch|Time Glitch]]
* [[HPL3/Scripting/Chromatic Aberration|Sway]]
+
* [[HPL3/SOMA/Scripting/Flash|Flash]]
* [[HPL3/Scripting/Chromatic Aberration|Time Glitch]]
+
* [[HPL3/SOMA/Scripting/Gamepad|Gamepad]]
* [[HPL3/Scripting/Chromatic Aberration|Tone Mapping]]
+
* [[HPL3/SOMA/Scripting/Lens Distortion|Lens Distortion]]
* [[HPL3/Scripting/Chromatic Aberration|Video Distortion]]
+
* [[HPL3/SOMA/Scripting/Video Distortion|Video Distortion]]
  
 
== Base ==
 
== Base ==
  
 
=== Input ===
 
=== Input ===
* [[HPL3/Scripting/Input Handler|Input Handler]]
+
* [[HPL3/SOMA/Scripting/Input Handler|Input Handler]]
* [[HPL3/Scripting/Input Types|Input Types]]
+
* [[HPL3/SOMA/Scripting/Input Types|Input Types]]
  
 
=== Game Achievements ===
 
=== Game Achievements ===
* [[HPL3/Scripting/Achievement Handler|Achievement Handler]]
+
* [[HPL3/SOMA/Scripting/Achievement Handler|Achievement Handler]]
* [[HPL3/Scripting/Achievement Types|Achievement Types]]
+
* [[HPL3/SOMA/Scripting/Achievement Types|Achievement Types]]
  
 
== Resources ==
 
== Resources ==
 +
*[https://www.angelcode.com/angelscript/sdk/docs/manual/index.html AngelScript Documentation]
  
 
{{CategoryEnd}}
 
{{CategoryEnd}}

Latest revision as of 19:06, 29 August 2020

Wip icon.png This category and its sub-pages are undergoing major editing, as some information in this category and all the sub pages is currently in the process of being formatted or re-written from scratch to achieve a higher standard of formatting, or not everything is yet available. More pages and information will gradually be added.


This category deals with Scripting and Programming in HPL3 and SOMA. Everything regarding map scripting, gameplay programming and low-level engine topics are covered here.

Advice

Getting Started


General

Helpers

User Modules

General

Player

Gameplay

Effects

Interfaces

GUI

NPCs

Player

Effects

Base

Input

Game Achievements

Resources