TopDown Engine v4.5
Loading...
Searching...
No Matches
MoreMountains.TopDownEngine.MovementZone Class Reference

Add this class to a trigger collider and it will let you apply a movement speed multiplier to characters entering it. More...

Inheritance diagram for MoreMountains.TopDownEngine.MovementZone:
MoreMountains.TopDownEngine.ButtonActivated MoreMountains.TopDownEngine.TopDownMonoBehaviour MoreMountains.Tools.MMMonoBehaviour

Classes

class  MovementZoneCollidingEntity
 A class used to store a movement zone's settings. More...

Public Member Functions

override void Initialization ()
 On init, we initialize our list.
override void TriggerButtonAction ()
 When the button is pressed we start modifying the timescale.
virtual void ChangeSpeed ()
 Changes the speed of CharacterMovement equipped characters that enter the zone.
override void TriggerExitAction (GameObject collider)
 When exiting, and if needed, we reset the character's speed and remove it from our list.
Public Member Functions inherited from MoreMountains.TopDownEngine.ButtonActivated
virtual void TriggerEnterAction (GameObject collider)
virtual void MakeActivable ()
 Makes the zone activable.
virtual void MakeUnactivable ()
 Makes the zone unactivable.
virtual void ToggleActivable ()
 Makes the zone activable if it wasn't, unactivable if it was activable.
virtual void PromptError ()
 Triggers an error.
virtual void ShowPrompt ()
 Shows the button A prompt.
virtual void HidePrompt ()
 Hides the button A prompt.
virtual void DisableZone ()
 Disables the button activated zone.
virtual void EnableZone ()
 Enables the button activated zone.
virtual bool CheckNumberOfUses ()
 Checks the remaining number of uses and eventual delay between uses and returns true if the zone can be activated.

Public Attributes

float MovementSpeedMultiplier = 0.5f
 the new movement multiplier to apply
Public Attributes inherited from MoreMountains.TopDownEngine.ButtonActivated
ButtonActivatedRequirements ButtonActivatedRequirement = ButtonActivatedRequirements.Either
 if this is true, objects with a ButtonActivator class will be able to interact with this zone
bool RequiresPlayerType = true
 if this is true, this can only be activated by player Characters
bool RequiresButtonActivationAbility = true
 if this is true, this zone can only be activated if the character has the required ability
bool Activable = true
 if this is false, the zone won't be activable
bool AutoActivation = false
 if true, the zone will activate whether the button is pressed or not
bool AutoActivationAndButtonInteraction = false
 if true, this zone will be auto activated but will still allow button interaction
float AutoActivationDelay = 0f
 the delay, in seconds, during which the character has to be within the zone to activate it
bool AutoActivationDelayResetsOnExit = true
 if this is true, exiting the zone will reset the auto activation delay
bool CanOnlyActivateIfGrounded = false
 if this is set to false, the zone won't be activable while not grounded
bool ShouldUpdateState = true
 Set this to true if you want the CharacterBehaviorState to be notified of the player's entry into the zone.
bool OnlyOneActivationAtOnce = true
 if this is true, enter won't be retriggered if another object enters, and exit will only be triggered when the last object exits
LayerMask TargetLayerMask = ~0
 a layermask with all the layers that can interact with this specific button activated zone
bool UnlimitedActivations = true
 if this is set to false, your number of activations will be MaxNumberOfActivations
int MaxNumberOfActivations = 0
 the number of times the zone can be interacted with
int NumberOfActivationsLeft
 the amount of remaining activations on this zone
float DelayBetweenUses = 0f
 the delay (in seconds) after an activation during which the zone can't be activated
bool DisableAfterUse = false
 if this is true, the zone will disable itself (forever or until you manually reactivate it) after its last use
InputTypes InputType = InputTypes.Default
 the selected input type (default, button or key)
string InputButton = "Interact"
 the selected button string used to activate this zone
KeyCode InputKey = KeyCode.Space
 the key used to activate this zone
string AnimationTriggerParameterName
 an (absolutely optional) animation parameter that can be triggered on the character when activating the zone
bool UseVisualPrompt = true
 if this is true, a prompt will be shown if setup properly
ButtonPrompt ButtonPromptPrefab
 the gameobject to instantiate to present the prompt
string ButtonPromptText = "A"
 the text to display in the button prompt
Color ButtonPromptColor = MMColors.LawnGreen
 the text to display in the button prompt
Color ButtonPromptTextColor = MMColors.White
 the color for the prompt's text
bool AlwaysShowPrompt = true
 If true, the "buttonA" prompt will always be shown, whether the player is in the zone or not.
bool ShowPromptWhenColliding = true
 If true, the "buttonA" prompt will be shown when a player is colliding with the zone.
bool HidePromptAfterUse = false
 If true, the prompt will hide after use.
Vector3 PromptRelativePosition = Vector3.zero
 the position of the actual buttonA prompt relative to the object's center
Vector3 PromptRotation = Vector3.zero
 the rotation of the actual buttonA prompt
MMFeedbacks ActivationFeedback
 a feedback to play when the zone gets activated
MMFeedbacks DeniedFeedback
 a feedback to play when the zone tries to get activated but can't
MMFeedbacks EnterFeedback
 a feedback to play when the zone gets entered
MMFeedbacks ExitFeedback
 a feedback to play when the zone gets exited
UnityEvent OnActivation
 a UnityEvent to trigger when this zone gets activated
UnityEvent OnEnter
 a UnityEvent to trigger when this zone gets entered
UnityEvent OnExit
 a UnityEvent to trigger when this zone gets exited
UnityEvent OnStay
 a UnityEvent to trigger when a character is within the zone

Protected Attributes

List< MovementZoneCollidingEntityCollidingEntities
Protected Attributes inherited from MoreMountains.TopDownEngine.ButtonActivated
Animator _buttonPromptAnimator
ButtonPrompt _buttonPrompt
Collider _collider
Collider2D _collider2D
bool _promptHiddenForever = false
CharacterButtonActivation _characterButtonActivation
float _lastActivationTimestamp
List< GameObject > _collidingObjects
Character _currentCharacter
bool _staying = false
Coroutine _autoActivationCoroutine

Additional Inherited Members

Public Types inherited from MoreMountains.TopDownEngine.ButtonActivated
enum  ButtonActivatedRequirements { Character , ButtonActivator , Either , None }
enum  InputTypes { Default , Button , Key }
Protected Member Functions inherited from MoreMountains.TopDownEngine.ButtonActivated
virtual void OnEnable ()
 On Enable, we initialize our ButtonActivated zone.
virtual void OnDisable ()
 On disable we disable our input action if needed.
virtual IEnumerator TriggerButtonActionCo ()
virtual void Update ()
virtual void ActivateZone ()
 Activates the zone.
virtual void OnTriggerEnter2D (Collider2D collidingObject)
 Handles enter collision with 2D triggers.
virtual void OnTriggerExit2D (Collider2D collidingObject)
 Handles enter collision with 2D triggers.
virtual void OnTriggerEnter (Collider collidingObject)
 Handles enter collision with 2D triggers.
virtual void OnTriggerExit (Collider collidingObject)
 Handles enter collision with 2D triggers.
virtual void TriggerEnter (GameObject collider)
 Triggered when something collides with the button activated zone.
virtual void TriggerExit (GameObject collider)
 Triggered when something exits the water.
virtual bool TestForLastObject (GameObject collider)
 Tests if the object exiting our zone is the last remaining one.
virtual bool CheckConditions (GameObject collider)
 Determines whether or not this zone should be activated.
Properties inherited from MoreMountains.TopDownEngine.ButtonActivated
virtual bool AutoActivationInProgress [get, set]
virtual float AutoActivationStartedAt [get, set]
bool InputActionPerformed [get]

Detailed Description

Add this class to a trigger collider and it will let you apply a movement speed multiplier to characters entering it.

Member Function Documentation

◆ ChangeSpeed()

virtual void MoreMountains.TopDownEngine.MovementZone.ChangeSpeed ( )
virtual

Changes the speed of CharacterMovement equipped characters that enter the zone.

◆ Initialization()

override void MoreMountains.TopDownEngine.MovementZone.Initialization ( )
virtual

On init, we initialize our list.

Reimplemented from MoreMountains.TopDownEngine.ButtonActivated.

◆ TriggerButtonAction()

override void MoreMountains.TopDownEngine.MovementZone.TriggerButtonAction ( )
virtual

When the button is pressed we start modifying the timescale.

Reimplemented from MoreMountains.TopDownEngine.ButtonActivated.

◆ TriggerExitAction()

override void MoreMountains.TopDownEngine.MovementZone.TriggerExitAction ( GameObject collider)
virtual

When exiting, and if needed, we reset the character's speed and remove it from our list.

Parameters
collider

Reimplemented from MoreMountains.TopDownEngine.ButtonActivated.

Member Data Documentation

◆ CollidingEntities

List<MovementZoneCollidingEntity> MoreMountains.TopDownEngine.MovementZone.CollidingEntities
protected

◆ MovementSpeedMultiplier

float MoreMountains.TopDownEngine.MovementZone.MovementSpeedMultiplier = 0.5f

the new movement multiplier to apply


The documentation for this class was generated from the following file:
  • H:/Code/MoreMountains/topdownengine/Assets/TopDownEngine/Common/Scripts/Environment/MovementZone.cs