WallDetectorInfo Class Reference

Detailed Description

This script is used by some entities (including the player) to detect when they are touching a wall. If either side of the entity is touching the wall, onWall is set to true. When the wall detector consists of two trigger zones, frontOnWall and backOnWall become available.

WallDetectorZone.cs is what updates this script. See WallDetectorZone.cs for more info!

Documentation updated 12/19/2024

Author

Alexander Art

Public Member Functions
void	wallTouched (WallDetectorSide side)
void	wallUntouched (WallDetectorSide side)

Public Attributes
LayerMask	wallLayer
	The layers which objects are considered part of the wall are on.

Properties
bool	onWall [get, private set]
	True when either side of the entity is touching a wall.
bool	frontOnWall [get, private set]
	True when there is a front trigger zone and it is touching a wall.
bool	backOnWall [get, private set]
	True when there is a back trigger zone and it is touching a wall.

Member Function Documentation

wallTouched()

void WallDetectorInfo.wallTouched

(

WallDetectorSide

side

)

wallUntouched()

void WallDetectorInfo.wallUntouched

(

WallDetectorSide

side

)

Member Data Documentation

wallLayer

LayerMask WallDetectorInfo.wallLayer

The layers which objects are considered part of the wall are on.

Property Documentation

backOnWall

bool WallDetectorInfo.backOnWall

getprivate set

True when there is a back trigger zone and it is touching a wall.

frontOnWall

bool WallDetectorInfo.frontOnWall

getprivate set

True when there is a front trigger zone and it is touching a wall.

onWall

bool WallDetectorInfo.onWall

getprivate set

True when either side of the entity is touching a wall.

---

The documentation for this class was generated from the following file:

• Assets/Scripts/Entities/Collision/WallDetectorInfo.cs