Corgi Engine  v8.8
MoreMountains.CorgiEngine.Ledge Class Reference

Add this component to an object and it'll be able to be grabbed by characters equipped with a CharacterLedgeHang ability More...

Inheritance diagram for MoreMountains.CorgiEngine.Ledge:
MoreMountains.CorgiEngine.CorgiMonoBehaviour

Public Types

enum  LedgeGrabDirections { LedgeGrabDirections.Left, LedgeGrabDirections.Right }
 the direction ledges can be grabbed from (left means it can be grabbed by a character facing left) More...
 

Public Attributes

LedgeGrabDirections LedgeGrabDirection = LedgeGrabDirections.Left
 the direction this ledge gets grabbed from More...
 
Vector3 HangOffset
 the offset to apply when hanging to this ledge More...
 
Vector3 ClimbOffset
 the offset to apply when climb is complete More...
 

Protected Member Functions

virtual void OnTriggerEnter2D (Collider2D collider)
 When something collides with our ledge collider, we trigger a LedgeEvent More...
 
virtual void OnDrawGizmosSelected ()
 Draws a blue point at the HangOffset position, and an orange one at the point the Character will get teleported to at the end of the climb Now you're thinking with portals. More...
 

Static Protected Attributes

const string _playerTag = "Player"
 the tag used to reference the player More...
 

Detailed Description

Add this component to an object and it'll be able to be grabbed by characters equipped with a CharacterLedgeHang ability

Member Enumeration Documentation

◆ LedgeGrabDirections

the direction ledges can be grabbed from (left means it can be grabbed by a character facing left)

Enumerator
Left 
Right 

Member Function Documentation

◆ OnDrawGizmosSelected()

virtual void MoreMountains.CorgiEngine.Ledge.OnDrawGizmosSelected ( )
protectedvirtual

Draws a blue point at the HangOffset position, and an orange one at the point the Character will get teleported to at the end of the climb Now you're thinking with portals.

◆ OnTriggerEnter2D()

virtual void MoreMountains.CorgiEngine.Ledge.OnTriggerEnter2D ( Collider2D  collider)
protectedvirtual

When something collides with our ledge collider, we trigger a LedgeEvent

Parameters
collider

Member Data Documentation

◆ _playerTag

const string MoreMountains.CorgiEngine.Ledge._playerTag = "Player"
staticprotected

the tag used to reference the player

◆ ClimbOffset

Vector3 MoreMountains.CorgiEngine.Ledge.ClimbOffset

the offset to apply when climb is complete

◆ HangOffset

Vector3 MoreMountains.CorgiEngine.Ledge.HangOffset

the offset to apply when hanging to this ledge

◆ LedgeGrabDirection

LedgeGrabDirections MoreMountains.CorgiEngine.Ledge.LedgeGrabDirection = LedgeGrabDirections.Left

the direction this ledge gets grabbed from


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