TopDown Engine  v3.6
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
MoreMountains.TopDownEngine.DashZone3D Class Reference

Add this zone to a trigger collider and it'll automatically trigger a dash on your 3D character on entry More...

Inheritance diagram for MoreMountains.TopDownEngine.DashZone3D:
MoreMountains.TopDownEngine.TopDownMonoBehaviour MoreMountains.Tools.MMMonoBehaviour

Public Member Functions

virtual void SetColliderTrigger (bool status)
 Sets this collider's trigger off or on More...
 

Public Attributes

Collider CoverObstacleCollider
 the collider of the obstacle you want to dash over More...
 
List< DashZone3D > ExitDashZones
 the (optional) exit dash zone on the other side of the collider More...
 
float DashDistance = 3f
 the distance of the dash triggered when entering the zone More...
 
float DashDuration
 the duration of the dash More...
 
AnimationCurve DashCurve = new AnimationCurve(new Keyframe(0f, 0f), new Keyframe(1f, 1f))
 the curve to apply to the dash More...
 
float MaxFacingAngle = 90f
 the max angle at which the character should approach the obstacle for the dash to happen More...
 
float TriggerResetDuration = 1f
 the duration in seconds before re-enabling all triggers in the zone More...
 
bool DashAuthorized = true
 if this is false, the dash won't happen More...
 

Protected Member Functions

virtual void Start ()
 On start we initialize our zone More...
 
virtual void Initialization ()
 Grabs collider and readies the wait for seconds More...
 
virtual void OnTriggerEnter (Collider collider)
 On trigger enter, we ready our dash More...
 
virtual void OnTriggerStay (Collider collider)
 On trigger enter, we ready our dash More...
 
virtual void TestForDash (Collider collider)
 Makes sure the collider matches our specs, and the angle is right. If yes, triggers the dash sequence More...
 
virtual IEnumerator DashSequence ()
 Sets the dash properties, triggers the dash, and resets everything afterwards More...
 

Protected Attributes

CharacterDash3D _characterDash3D
 
CharacterHandleWeapon _characterHandleWeapon
 
WeaponAim3D _weaponAim3D
 
CharacterOrientation3D _characterOrientation3D
 
CharacterOrientation3D.RotationModes _rotationMode
 
WeaponAim.AimControls _weaponAimControl
 
Character _character
 
Collider _collider
 
WaitForSeconds _dashWaitForSeconds
 
WaitForSeconds _triggerResetForSeconds
 
Vector3 _direction1
 
Vector3 _direction2
 
bool _dashInProgress = false
 

Detailed Description

Add this zone to a trigger collider and it'll automatically trigger a dash on your 3D character on entry

Member Function Documentation

◆ DashSequence()

virtual IEnumerator MoreMountains.TopDownEngine.DashZone3D.DashSequence ( )
protectedvirtual

Sets the dash properties, triggers the dash, and resets everything afterwards

Returns

◆ Initialization()

virtual void MoreMountains.TopDownEngine.DashZone3D.Initialization ( )
protectedvirtual

Grabs collider and readies the wait for seconds

◆ OnTriggerEnter()

virtual void MoreMountains.TopDownEngine.DashZone3D.OnTriggerEnter ( Collider  collider)
protectedvirtual

On trigger enter, we ready our dash

Parameters
collider

◆ OnTriggerStay()

virtual void MoreMountains.TopDownEngine.DashZone3D.OnTriggerStay ( Collider  collider)
protectedvirtual

On trigger enter, we ready our dash

Parameters
collider

◆ SetColliderTrigger()

virtual void MoreMountains.TopDownEngine.DashZone3D.SetColliderTrigger ( bool  status)
virtual

Sets this collider's trigger off or on

Parameters
status

◆ Start()

virtual void MoreMountains.TopDownEngine.DashZone3D.Start ( )
protectedvirtual

On start we initialize our zone

◆ TestForDash()

virtual void MoreMountains.TopDownEngine.DashZone3D.TestForDash ( Collider  collider)
protectedvirtual

Makes sure the collider matches our specs, and the angle is right. If yes, triggers the dash sequence

Member Data Documentation

◆ _character

Character MoreMountains.TopDownEngine.DashZone3D._character
protected

◆ _characterDash3D

CharacterDash3D MoreMountains.TopDownEngine.DashZone3D._characterDash3D
protected

◆ _characterHandleWeapon

CharacterHandleWeapon MoreMountains.TopDownEngine.DashZone3D._characterHandleWeapon
protected

◆ _characterOrientation3D

CharacterOrientation3D MoreMountains.TopDownEngine.DashZone3D._characterOrientation3D
protected

◆ _collider

Collider MoreMountains.TopDownEngine.DashZone3D._collider
protected

◆ _dashInProgress

bool MoreMountains.TopDownEngine.DashZone3D._dashInProgress = false
protected

◆ _dashWaitForSeconds

WaitForSeconds MoreMountains.TopDownEngine.DashZone3D._dashWaitForSeconds
protected

◆ _direction1

Vector3 MoreMountains.TopDownEngine.DashZone3D._direction1
protected

◆ _direction2

Vector3 MoreMountains.TopDownEngine.DashZone3D._direction2
protected

◆ _rotationMode

CharacterOrientation3D.RotationModes MoreMountains.TopDownEngine.DashZone3D._rotationMode
protected

◆ _triggerResetForSeconds

WaitForSeconds MoreMountains.TopDownEngine.DashZone3D._triggerResetForSeconds
protected

◆ _weaponAim3D

WeaponAim3D MoreMountains.TopDownEngine.DashZone3D._weaponAim3D
protected

◆ _weaponAimControl

WeaponAim.AimControls MoreMountains.TopDownEngine.DashZone3D._weaponAimControl
protected

◆ CoverObstacleCollider

Collider MoreMountains.TopDownEngine.DashZone3D.CoverObstacleCollider

the collider of the obstacle you want to dash over

◆ DashAuthorized

bool MoreMountains.TopDownEngine.DashZone3D.DashAuthorized = true

if this is false, the dash won't happen

◆ DashCurve

AnimationCurve MoreMountains.TopDownEngine.DashZone3D.DashCurve = new AnimationCurve(new Keyframe(0f, 0f), new Keyframe(1f, 1f))

the curve to apply to the dash

◆ DashDistance

float MoreMountains.TopDownEngine.DashZone3D.DashDistance = 3f

the distance of the dash triggered when entering the zone

◆ DashDuration

float MoreMountains.TopDownEngine.DashZone3D.DashDuration

the duration of the dash

◆ ExitDashZones

List<DashZone3D> MoreMountains.TopDownEngine.DashZone3D.ExitDashZones

the (optional) exit dash zone on the other side of the collider

◆ MaxFacingAngle

float MoreMountains.TopDownEngine.DashZone3D.MaxFacingAngle = 90f

the max angle at which the character should approach the obstacle for the dash to happen

◆ TriggerResetDuration

float MoreMountains.TopDownEngine.DashZone3D.TriggerResetDuration = 1f

the duration in seconds before re-enabling all triggers in the zone

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