Frictional Game Wiki

User Tools

Site Tools

Trace:
hpl3:game:scripting:user_modules

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision 		Previous revision
hpl3:game:scripting:user_modules [2015/09/11 11:42]
ian.thomas 		hpl3:game:scripting:user_modules [2015/10/29 09:48] (current)
luis
Line 1: Line 1:
 ====== User Modules ====== ====== User Modules ======
  
-===== Overview =====+What follows is a list of all the premade user modules that come with the game.
  
-What follows is a list of all the premade user modules that come with the game. All of these have helper functions that can be access by looking for functions with the prefix displayed for each module. +    ​* [[:hpl3:​game:​scripting:​user_modules:​camera_animation|Camera Animation]] - Handles animating ​the player's viewpoint. 
- +    * [[:​hpl3:​game:​scripting:​user_modules:​attack_meter|Attack Meter]] - Handles attacking effects, knock-down, and dying. 
-===== Interactive camera animation ===== +    * [[:​hpl3:​game:​scripting:​user_modules:​credits|Credits]] ​- Shows the list of people who made the game. 
- +    * [[:​hpl3:​game:​scripting:​user_modules:​datamine|Datamine]] - Allows ​the player to listen ​to the last few moments of audio in a buffer. 
-**Helper function prefix:** CameraAnimation +    * [[:​hpl3:​game:​scripting:​user_modules:​description|Description]] - Obsolete module not used in SOMA. 
-==== General ==== +    * [[:​hpl3:​game:​scripting:​user_modules:​distortion_effects|Distortion Effects]] - Distortion ​and static on the player's vision. 
- +    * [[:​hpl3:​game:​scripting:​user_modules:​emotion|Emotion]] - Handles ​the player's heartbeat ​and breathing. 
-The camera animation system is used to move the player ​camera along a specific path while still allowing some degree of interaction. +    * [[:​hpl3:​game:​scripting:​user_modules:​game_over|Game Over]] - Shows a series of death screens, and displays ​the game over text. 
- +    * [[:​hpl3:​game:​scripting:​user_modules:​highlight_effect|Highlight Effect]] - Highlights interactable objects near the player. 
-==== Instructions ==== +    * [[:​hpl3:​game:​scripting:​user_modules:​hint|Hint]] - Shows hints at the top of the screen. 
- +    * [[:​hpl3:​game:​scripting:​user_modules:​inventory|Inventory]] - Handles ​the display of the player's inventory. 
-To use the system, place CameraAnimation nodes (Area → CameraAnimation) in the scene and give each of them the name of the animation followed by an underscore and their placement within the animation (such as WakeUpAnimation_1,​ WakeUpAnimation_2 etc). Note that if you duplicate (Ctrl-D) a node, the duplicate will automatically get the next available number as its suffix.\\ +    * [[:​hpl3:​game:​scripting:​user_modules:​light_flash|Light Flash]] - Creates a bright flash of light at a point in the gameworld. 
-Rotate the nodes so that their Z-axes point in the direction you want the camera to look at that part of the animation. \\ +    * [[:​hpl3:​game:​scripting:​user_modules:​map_effects|Map Effects]] - Handles environmental particles and fog. 
-In script, call the helper function CameraAnimation_Begin() to start the animation. +    * [[:​hpl3:​game:​scripting:​user_modules:​menu|Menu]] - The whole front-end menu system for SOMA. 
- +    * [[:​hpl3:​game:​scripting:​user_modules:​player_energy|Player Energy]] - Handles the draining of Wau flowers for healing. 
-==== Node properties ==== +    * [[:​hpl3:​game:​scripting:​user_modules:​player_hands|Player Hands]] - Handles player hand animations. 
- +    ​* ​Player Pickup ​- Obsolete module not used in SOMA. 
-**MaxYaw/​MaxPitch** \\ +    * [[:​hpl3:​game:​scripting:​user_modules:​player_tool|Player Tool]] - Manages the player'​s inventory, and how picked up tools interact and animate. 
-Dictates how far the player ​is allowed ​to rotate the camera away from the target forward rotation. This value is interpolated between nodes. +    ​* ​Terrain Particles ​- Obsolete module not used in SOMA. 
- +    * [[:​hpl3:​game:​scripting:​user_modules:​wake_handler|Wake Handler]] - A simple eyelid-blinking effect.
-**LookSpeedMultiplier** \\ +
-How fast the player can rotate the camera. +
- +
-**ForwardTime\\ +
-** The time it takes to move from this node to the next at full speed forward. +
- +
-**BackwardTime** \\ +
-The time it takes to move from the next node to this one at full reverse speed. +
- +
-**AutoMovement** \\ +
-Dictates how the animation behaves when no movement input is given, or when movement input is disabled. 0 stops movement, 1 is as if given full forward speed (animation will finish after [ForwardTime] seconds), ​-1 is as if given full reverse speed. +
- +
-**LookMoveDistance\\ +
-** The length between this node and the next the player ​can move just by looking toward the next node, given as a value between 0 and 1. +
- +
-**LookMoveMaxAngle** \\ +
-The maximum angle away from the next node the player ​can look and still move forward. Only valid if LookMoveDistance > 0. +
- +
-**InteractiveMovement\\ +
-** If checked, the player can control the movement between this node and the next. If unchecked, the AutoMovement property has complete control ​over the movement and should not be set to 0. +
- +
-**CrouchOnExit\\ +
-** If checked, ​the player ​will automatically crouch if the animation is ended at this node. +
- +
-**InitToCamera\\ +
-** If checked, the node is given the orientation ​of the camera when the animation starts. This is very useful when you want the animation to have a smooth beginning, or you want to make sure the player ​is returned to where they were when the end node is reached. +
- +
-**CallbackFunc** \\ +
-Function ​in the level script that should be called when reaching this node. The syntax is bool FuncName(const tString &in asEntity, int alDirection),​ where asEntity is the name of the node and alDirection is 1 if moving forward and -1 if moving backward. +
- +
-====== Attack Meter ====== +
-====== Credits ====== +
-====== Datamine ====== +
-====== Description ====== +
-====== Distortion Effects ====== +
-====== Emotion ====== +
-====== Game Over ====== +
-====== Highlight Effect ====== +
-====== Hint ====== +
-====== Inventory ====== +
-====== Light Flash ====== +
-====== Load Screen ====== +
-====== ​Map Effects ​====== +
-====== ​Menu ====== +
-====== ​Player Energy ​====== +
-====== ​Player Hands ====== +
-====== ​Player Pickup ​====== +
-====== ​Player Tool ====== +
-====== ​Terrain Particles ​====== +
-====== ​Wake Handler ​======+
  
hpl3/game/scripting/user_modules.1441971776.txt.gz · Last modified: 2015/09/11 11:42 by ian.thomas

Page Tools

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki