Difference between revisions of "HPL3/Areas/Ladder Area"

From Frictional Wiki
Jump to navigation Jump to search
(Created page with "== Overview == When placed on a static object (like a ladder), the Ladder area will allow the player to climb it. == Properties == === Material === Determines the type of sou...")
 
(Rewrote article to be more concise and added missing information)
 
Line 1: Line 1:
 
== Overview ==
 
== Overview ==
When placed on a static object (like a ladder), the Ladder area will allow the player to climb it.
+
The Ladder Area allows players to climb a ladder. This area will also cause the climbing hands animation. If the animation of the hands does not meet the spokes of the ladder then the area must be carefully moved while grid snap is disabled. In order to work properly, an [[HPL3/Areas/InteractAux Area|InteractAux Area]] with its '''InteractParent''' property set to the Ladder Area must be placed next to the Trigger Area, as seen in the image.
  
 
== Properties ==
 
== Properties ==
=== Material ===
+
[[Image:Ladder.png|thumb|A functioning ladder setup. Light green = Ladder Area, bluegreen = InteractAux Area, red = Trigger Area|right]]
Determines the type of sounds the player will make when climbing.
+
The  where the player will end up when exiting the ladder from the top.
 +
=== Base ===
 +
* '''Material''': The type of sound effect to play while climbing
 +
* '''Exit_Top''': The [[HPL3/Areas/Trigger Area|Trigger Area]] the players feet will be move to when exiting the ladder from the top
 +
* '''Exit_TopCrouching''': If the player should be crouched after exiting the ladder from the top
 +
* '''Exit_Bottom''': The [[HPL3/Areas/Trigger Area|Trigger Area]] the players feet will be move to when exiting the ladder from the bottom
 +
* '''Exit_BottomCrouching''': If the player should be crouched after exiting the ladder from the bottom
  
=== Exit_Top ===
 
[[Image:Ladder.png|thumb|A functioning ladder setup. Light green = Ladder, blue = InteractAux, red = Trigger|right]]
 
The [[HPL3/Areas/Trigger Area|Trigger area]] where the player will end up when exiting the ladder from the top. In order to work properly, an [[HPL3/Areas/InteractAux Area|InteractAux area]] with its '''InteractParent''' property set to the Ladder area must be placed next to the Trigger area, as seen in the image.
 
  
=== Exit_Bottom ===
+
 
Same as '''Exit_Top''' but for exiting from the bottom.
+
=== Attachment ===
 +
* '''ParentAttachEntity''': The name of an entity that this soundscape is parented to.
 +
* '''ParentAttachUseRotation''': If the rotation of the parent should affect the soundscape.
 +
* '''ParentAttachBody''': The name of the body in the parent entity to attach to.

Latest revision as of 23:40, 25 January 2024

Overview

The Ladder Area allows players to climb a ladder. This area will also cause the climbing hands animation. If the animation of the hands does not meet the spokes of the ladder then the area must be carefully moved while grid snap is disabled. In order to work properly, an InteractAux Area with its InteractParent property set to the Ladder Area must be placed next to the Trigger Area, as seen in the image.

Properties

A functioning ladder setup. Light green = Ladder Area, bluegreen = InteractAux Area, red = Trigger Area

The where the player will end up when exiting the ladder from the top.

Base

  • Material: The type of sound effect to play while climbing
  • Exit_Top: The Trigger Area the players feet will be move to when exiting the ladder from the top
  • Exit_TopCrouching: If the player should be crouched after exiting the ladder from the top
  • Exit_Bottom: The Trigger Area the players feet will be move to when exiting the ladder from the bottom
  • Exit_BottomCrouching: If the player should be crouched after exiting the ladder from the bottom


Attachment

  • ParentAttachEntity: The name of an entity that this soundscape is parented to.
  • ParentAttachUseRotation: If the rotation of the parent should affect the soundscape.
  • ParentAttachBody: The name of the body in the parent entity to attach to.