User Tools

Site Tools


hpl3:game:prop_types

Differences

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

Link to this comparison view

Both sides previous revision Previous revision
hpl3:game:prop_types [2015/09/18 10:34]
ian.thomas
hpl3:game:prop_types [2015/09/18 10:41] (current)
ian.thomas
Line 3: Line 3:
 Most props can be manipulated in some way using ''​Prop_''​ helper functions (and normal ''​Entity_''​ helper functions). Most props can be manipulated in some way using ''​Prop_''​ helper functions (and normal ''​Entity_''​ helper functions).
  
-===== Prop_Lamp ​===== +===== Prop_Button ​===== 
-Very straightforward - a prop which can have illumination switched on and off with ''​Lamp_SetLit''​. Often connected to additional in-level lights. Can be controlled through ''​Lamp_''​ helper functions.+A button that can be locked, disabled or enabled. Can be controlled through ''​Button_''​ helper functions.
  
-===== Prop_Grab ​===== +===== Prop_CatherineTool ​===== 
-A physics-based prop that can be picked up, turned and examined by the playerMake sure the body mass isn't 0!+The OmnitoolUse ''​CathTool_''​ helper methods. ​
  
-===== Prop_Push ​===== +===== Prop_Datamine ​===== 
-A physics-based prop that can be grabbed and pushed around (but not picked up).+An object which can be datamined by the player to pull out the last recorded audio. Use ''​Datamine_''​ helper functions. You can also use [[hpl3:​game:​areas#​datamine|Datamine Areas]] for this.
  
-===== Prop_Wheel ​===== +===== Prop_EnergySource ​===== 
-turnable wheel, such as a valve wheelMust have a Hinge joint. Can be controlled through ​''​Wheel_''​ helper ​functions.+source of healing energy - the Wau flowerUse ''​EnergySource_''​ helper ​methods and use along with the [[hpl3:​game:​scripting:​user_modules:​player_energy|Player Energy]] user module.
  
-===== Prop_Rigid ​===== +===== Prop_Grab ​===== 
-The basic physics-based ​object; ​can'​t ​be interacted with by default.+physics-based ​prop that can be picked up, turned and examined ​by the playerMake sure the body mass isn't 0!
  
-===== Prop_Slide ​===== +===== Prop_HandheldTerminal ​===== 
-An object with a body in it that can be grabbed ​and slid along a joint e.g. a drawer. Must include a Slider joint. Can be controlled through ​''​Slide_''​ helper functions.+Same as terminal, but can be picked up. Used for Datapads, mobile phones ​and camerasUse ''​Terminal_''​ helper functions ​and see [[hpl3:​game:​gui|GUI]] for more info.
  
-===== Prop_SwingDoor ​===== +===== Prop_HudObject ​===== 
-A door that swings. :-D. Can be controlled through ​''​SwingDoor_''​ helper functions.+An object which will be used as the 'held in hands' ​version of a Prop_Tool.
  
-===== Prop_Button ​===== +===== Prop_Lamp ​===== 
-A button that can be locked, disabled or enabled. Can be controlled through ''​Button_''​ helper functions.+Very straightforward - a prop which can have illumination switched on and off with ''​Lamp_SetLit''​. Often connected to additional in-level lights. Can be controlled through ''​Lamp_''​ helper functions.
  
 ===== Prop_LevelDoor ===== ===== Prop_LevelDoor =====
 An object which, when interacted with, will load a new level. Nearly obsolete now due to level streaming. An object which, when interacted with, will load a new level. Nearly obsolete now due to level streaming.
 +
 +===== Prop_Lever =====
 +Any sort of lever. Needs a Hinge joint. Use ''​Lever_''​ helper functions.
 +
 +===== Prop_Meter =====
 +For creating analogue meters, where a needle rotates across a display (can also be used for analogue clocks). Use ''​Meter_''​ helper functions.
  
 ===== Prop_MoveObject ===== ===== Prop_MoveObject =====
 An object which can be smoothly moved or rotated between two different points e.g. a ladder that slides into place, or a wall that turns to reveal a secret passage, or a cargo lift. Use ''​MoveObject_''​ helper functions. An object which can be smoothly moved or rotated between two different points e.g. a ladder that slides into place, or a wall that turns to reveal a secret passage, or a cargo lift. Use ''​MoveObject_''​ helper functions.
 +
 +===== Prop_MovingButton =====
 +A button object which has a moving or rotating component e.g. a pushbutton or a tap. Can be manipulated in different ways. Use ''​MovingButton_''​ helper functions.
  
 ===== Prop_MultiSlider ===== ===== Prop_MultiSlider =====
 Like a slider, but has multiple positions / states (not used in SOMA). Like a slider, but has multiple positions / states (not used in SOMA).
  
-===== Prop_SlideDoor ​===== +===== Prop_OmniSlot ​===== 
-door that slides open - use ''​SlideDoor_''​ helper ​functions.+slot which you can plug the Omnitool into. Use ''​Omnislot_''​ and ''​CathTool_''​ helper ​methods
  
-===== Prop_Lever ​===== +===== Prop_OmnitoolPanel ​===== 
-Any sort of leverNeeds a Hinge joint. Use ''​Lever_''​ helper ​functions.+An Omnitool panel i.e. the ones you wave the Omnitool at to get access. Use ''​OmniPanel_''​ helper ​methods.
  
-===== Prop_Terminal ​===== +===== Prop_PlayerHands ​===== 
-An object with GUI surface on e.g. a computer monitor or door panel. Use ''​Terminal_''​ helper ​functions, and ''​ImGui_''​ functions ​for drawing on the GUI surface ​see [[hpl3:​game:​gui|GUI]] for more info.+A set of player hands containing ​whole bunch of animations for use with the [[hpl3:​game:​scripting:​user_modules:​player_hands|Player Hands]] user module. Use ''​PlayerHands_''​ helper ​methods. 
 + 
 +===== Prop_PhysicsSlideDoor ===== 
 +A physics-based version of the SlideDoor object - allows the player to manually move the door. Use ''​PhysicsSlideDoor_'' ​helper ​functions
 + 
 +===== Prop_Push ===== 
 +A physics-based prop that can be grabbed and pushed around (but not picked up).
  
 ===== Prop_Readable ===== ===== Prop_Readable =====
 An object which can be picked up, rotated, and has text associated with it e.g. a letter, a book. An object which can be picked up, rotated, and has text associated with it e.g. a letter, a book.
  
-===== Prop_HandheldTerminal ​===== +===== Prop_Rigid ​===== 
-Same as terminal, but can be picked up. Used for Datapads, mobile phones and cameras. Use ''​Terminal_''​ helper functions and see [[hpl3:​game:​gui|GUI]] for more info.+The basic physics-based object; ​can'​t ​be interacted with by default.
  
-===== Prop_Tool ​===== +===== Prop_Slide ​===== 
-Objects which can be picked up by the player ​and then go into the player'​s inventory ​e.g. computer chips, the Omnitool, the stun gunUsed in conjunction with [[hpl3:​game:​areas#​tool|Tool Areas]] and the [[hpl3:​game:​scripting:​user_modules:​player_tool|Player Tool Module]].+An object with a body in it that can be grabbed ​and slid along a joint e.g. a drawerMust include a Slider joint. Can be controlled through ''​Slide_''​ helper functions.
  
-===== Prop_MovingButton ​===== +===== Prop_SlideDoor ​===== 
-button object which has moving or rotating component e.g. a pushbutton or a tap. Can be manipulated in different ways. Use ''​MovingButton_''​ helper functions.+door that slides open on Slider joint - use ''​SlideDoor_''​ helper functions.
  
-===== Prop_HudObject ​===== +===== Prop_SwingDoor ​===== 
-An object which will be used as the 'held in hands' version of a Prop_Tool. +A door that swings:-D. Can be controlled through ​''​SwingDoor_''​ helper functions.
- +
-===== Prop_Meter ===== +
-For creating analogue meters, where a needle rotates across a display (can also be used for analogue clocks). Use ''​Meter_''​ helper functions.+
  
 ===== Prop_Tear ===== ===== Prop_Tear =====
 An object which allows one body to be '​torn'​ away from another by the player. Used for things like emergency covers on boxes. ​ An object which allows one body to be '​torn'​ away from another by the player. Used for things like emergency covers on boxes. ​
  
-===== Prop_PhysicsSlideDoor ​===== +===== Prop_Terminal ​===== 
-A physics-based version of the SlideDoor ​object ​- allows the player to manually move the door. Use ''​PhysicsSlideDoor_''​ helper functions.+An object ​with a GUI surface on e.g. a computer monitor or door panel. Use ''​Terminal_''​ helper functions, and ''​ImGui_''​ functions for drawing on the GUI surface - see [[hpl3:​game:​gui|GUI]] for more info.
  
-===== Prop_Datamine ​===== +===== Prop_Tool ​===== 
-An object ​which can be datamined ​by the player ​to pull out the last recorded audio. Use ''Datamine_''​ helper functionsYou can also use [[hpl3:​game:​areas#​datamine|Datamine ​Areas]] ​for this.+Objects ​which can be picked up by the player ​and then go into the player's inventory e.g. computer chips, the Omnitool, the stun gun. Used in conjunction with [[hpl3:​game:​areas#​tool|Tool Areas]] ​and the [[hpl3:​game:​scripting:​user_modules:​player_tool|Player Tool Module]].
  
-===== Prop_OmniSlot ​===== +===== Prop_Wheel ​===== 
-slot which you can plug the Omnitool intoUse ''​Omnislot_''​ and ''​CathTool_''​ helper methods.  +turnable wheel, such as a valve wheelMust have Hinge jointCan be controlled through ​''​Wheel_''​ helper ​functions.
- +
-===== Prop_EnergySource ===== +
-A source of healing energy - the Wau flower. Use ''​EnergySource_''​ helper methods and use along with the [[hpl3:​game:​scripting:​user_modules:​player_energy|Player Energy]] user module. +
- +
-===== Prop_PlayerHands ===== +
-A set of player hands containing ​whole bunch of animations for use with the [[hpl3:​game:​scripting:​user_modules:​player_hands|Player Hands]] user module. Use ''​PlayerHands_''​ helper methods. +
- +
-===== Prop_CatherineTool ===== +
-The Omnitool. Use ''​CathTool_''​ helper methods.  +
- +
-===== Prop_OmnitoolPanel ===== +
-An Omnitool panel i.e. the ones you wave the Omnitool at to get accessUse ''​OmniPanel_''​ helper ​methods.+
  
hpl3/game/prop_types.txt · Last modified: 2015/09/18 10:41 by ian.thomas