TopDown Engine

https://topdown-engine-docs.moremountains.com
Admin
TopDown Engine is a comprehensive Unity framework for creating 2D and 3D top-down games, providing...
Tokens:324,214
Snippets:4,531
Trust Score:7.7
Update:1 month ago
Show doc for...
Tokens:
Raw
### Start

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_top_down_engine_1_1_character_ability.html

Initializes the ability on start.

```APIDOC
## Start()

### Description
On Start(), the ability's initialization is performed.
```

--------------------------------

### StartListening

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_feedbacks_1_1_m_m_audio_source_volume_shaker.html

Starts listening for MMAudioSourceVolumeShakeEvents.

```APIDOC
### Method
void StartListening()

### Description
Registers the shaker to listen for incoming volume shake events.
```

--------------------------------

### Start()

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_tools_1_1_m_m_cooldown.html

Initiates the consumption of the cooldown object.

```APIDOC
## void Start()

### Description
Starts consuming the cooldown object if possible.
```

--------------------------------

### EvaluateRequiresSetup()

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_feedbacks_1_1_m_m_f___feedback.html

Determines if a feedback component requires setup. This method can be overridden in derived classes to provide custom logic for setup validation.

```APIDOC
## virtual bool EvaluateRequiresSetup()

### Description
Override this method to determine if a feedback requires setup.

### Returns
- **bool** - Returns true if the feedback requires setup, false otherwise.
```

--------------------------------

### Start

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_tools_1_1_m_m_cooldown.html

Attempts to start the consumption process of the cooldown object.

```APIDOC
### Start

#### Signature
`void Start()`

#### Description
Starts consuming the cooldown object if the current state allows it.
```

--------------------------------

### StartListening

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_feedbacks_1_1_m_m_shaker.html

Starts listening for events.

```APIDOC
### Method
void StartListening()

### Description
Starts listening for events.
```

--------------------------------

### Initialization()

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_tools_1_1_a_i_decision.html

Lifecycle method called when the game starts.

```APIDOC
## void Initialization()

### Description
Meant to be overridden, this method is called when the game starts to perform necessary setup for the decision.
```

--------------------------------

### StartFollowing

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_top_down_engine_1_1_magnetic.html

Starts the magnetic following behavior.

```APIDOC
## StartFollowing

### Description
Starts the magnetic following behavior for the object.

### Method
void StartFollowing()
```

--------------------------------

### StartRecording()

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_feedbacks_1_1_m_m_input_sequence_recorder.html

Starts the recording process and clears the sequence if necessary.

```APIDOC
## StartRecording()

### Description
Clears the sequence if needed and starts recording.
```

--------------------------------

### Initialization()

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_tools_1_1_m_m_parallax_u_i.html

Initializes the start position of all UI layers.

```APIDOC
## Initialization()

### Description
Initializes the start position of all layers.

### Signature
`virtual void Initialization()`
```

--------------------------------

### Play()

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_tools_1_1_m_m_playlist_remote.html

Starts playback of the playlist.

```APIDOC
## Play()

### Description
Plays the playlist.

### Signature
`virtual void Play()`
```

--------------------------------

### AutoSetup()

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_tools_1_1_m_m_aspect_ratio_safe_zones.html

Triggers the automatic setup process for the aspect ratio safe zones.

```APIDOC
## void AutoSetup()

### Description
Performs an automatic setup of the safe zones based on the current inspector configuration.

### Signature
`virtual void AutoSetup()`
```

--------------------------------

### Play()

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_tools_1_1_m_m_playlist_remote.html

Starts playback of the playlist.

```APIDOC
## Play()

### Description
Plays the current playlist.

### Signature
`void Play()`
```

--------------------------------

### Install

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_top_down_engine_1_1_package_installation-members.html

Installs a specific version of a package.

```APIDOC
## Install(string packageVersionID)

### Description
Installs the package associated with the provided version ID.

### Parameters
- **packageVersionID** (string) - The unique identifier for the package version to install.
```

--------------------------------

### AutoSetup

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_tools_1_1_m_m_aspect_ratio_safe_zones.html

Method to automatically configure the safe zones setup.

```APIDOC
## AutoSetup()

### Description
Performs an automatic setup for the aspect ratio safe zones component.
```

--------------------------------

### StartListening

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_feedbacks_1_1_m_m_light_shaker.html

Starts listening for shake events.

```APIDOC
## StartListening()

### Description
Registers the shaker to start listening for MMLightShakeEvents.
```

--------------------------------

### StartListening()

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_tools_1_1_m_m_radio_receiver.html

Starts listening for radio level events.

```APIDOC
### Method
`StartListening()`

### Description
Enables the receiver to start listening for radio level events on the configured channel.
```

--------------------------------

### StartFollowing()

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_top_down_engine_1_1_cinemachine_camera_controller.html

Starts following the LevelManager's main player.

```APIDOC
## StartFollowing

### Description
Starts following the LevelManager's main player.
```

--------------------------------

### OnEnable()

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_tools_1_1_m_m_debug_menu_button_event_listener.html

Starts listening for events.

```APIDOC
## OnEnable()

### Description
Starts listening for events.

### Signature
`virtual void OnEnable()`
```

--------------------------------

### Install(string packageVersionID)

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_top_down_engine_1_1_package_installation.html

Installs a specific version of a package into the engine.

```APIDOC
### Method
`void Install(string packageVersionID)`

### Description
Initiates the installation process for the package version specified by the provided packageVersionID.

### Parameters
- **packageVersionID** (string) - The identifier of the package version to install.
```

--------------------------------

### StartListening

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_feedbacks_1_1_m_m_camera_clipping_planes_shaker.html

Starts listening for camera clipping plane shake events.

```APIDOC
### Method
void StartListening()

### Description
Registers the shaker to listen for incoming MMCameraClippingPlanesShakeEvent events.
```

--------------------------------

### StartShaking

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_feedbacks_1_1_m_m_audio_source_volume_shaker.html

Starts the shaking process for the audio volume.

```APIDOC
## void StartShaking()

### Description
Initiates the shaking of the audio volume values.
```

--------------------------------

### OnEnable()

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_tools_1_1_m_m_debug_menu_checkbox_event_listener.html

Starts listening for events from the MMDebugMenu checkbox.

```APIDOC
## OnEnable()

### Description
Starts listening for events from the MMDebugMenu checkbox.

### Signature
`public virtual void OnEnable()`
```

--------------------------------

### Play

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_feedbacks_1_1_m_m_audio_filter_distortion_shaker.html

Starts the shaker component.

```APIDOC
## void Play()

### Description
Starts the execution of this shaker.
```

--------------------------------

### StartListening

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_feedbacks_1_1_m_m_scale_shaker.html

Starts listening for scale shake events.

```APIDOC
## StartListening()

### Description
Registers the component to listen for MMScaleShakeEvents, allowing it to trigger scale shake effects when events are received.

### Method
void StartListening()
```

--------------------------------

### StartShaking

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_feedbacks_1_1_m_m_rotation_shaker.html

Starts the shaking process for the values.

```APIDOC
## StartShaking

### Description
Starts shaking the values.
```

--------------------------------

### StartListening

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_feedbacks_1_1_m_m_audio_source_pitch_shaker.html

Starts listening for pitch shake events.

```APIDOC
## StartListening

### Description
Registers the shaker to listen for incoming pitch shake events.

### Signature
`public void StartListening()`
```

--------------------------------

### StartShaking

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_feedbacks_1_1_m_m_audio_source_pitch_shaker.html

Starts the shaking process for the audio pitch.

```APIDOC
## void StartShaking()

### Description
Starts shaking the values based on the configured settings.
```

--------------------------------

### StartShaking

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_feedbacks_1_1_m_m_camera_field_of_view_shaker.html

Starts the camera field of view shake process.

```APIDOC
### Method
void StartShaking()

### Description
Initiates the shaking of the field of view values based on the configured inspector settings.
```

--------------------------------

### StartShaking

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_feedbacks_1_1_m_m_audio_filter_high_pass_shaker.html

Starts the shaking process for the audio filter.

```APIDOC
## void StartShaking()

### Description
Initiates the shaking of the high-pass filter values.
```

--------------------------------

### StartShaking

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_feedbacks_1_1_m_m_audio_filter_distortion_shaker.html

Starts the shaking process for the distortion values.

```APIDOC
## void StartShaking()

### Description
Initiates the shaking of the distortion values.
```

--------------------------------

### Initialization()

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_tools_1_1_m_m_parallax_u_i.html

Initializes the starting position of all UI layers managed by the parallax rig.

```APIDOC
### void Initialization()

Initializes the start position of all layers. This should be called to prepare the parallax rig for movement calculations.
```

--------------------------------

### Initializing and Using Default Play Options

Source: https://topdown-engine-docs.moremountains.com/API/struct_more_mountains_1_1_tools_1_1_m_m_sound_manager_play_options.html

Demonstrates how to initialize a new options set from the default configuration, override specific properties, and trigger a sound play event.

```csharp
MMSoundManagerPlayOptions options = MMSoundManagerPlayOptions.Default; options.Loop = Loop; options.Location = Vector3.zero; options.MmSoundManagerTrack = MMSoundManager.MMSoundManagerTracks.Music;
MMSoundManagerSoundPlayEvent.Trigger(SoundClip, options);
```

--------------------------------

### SetupSounds()

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_feedbacks_1_1_m_m_audio_source_sequencer.html

Ensures the internal audio source array is correctly sized.

```APIDOC
## SetupSounds()

### Description
Ensures the internal array of audio sources is always the right length.
```

--------------------------------

### Initialization()

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_feedbacks_1_1_m_m_wiggle.html

Initializes the wiggle component by capturing start values and preparing coroutines.

```APIDOC
### Method
void Initialization()

### Description
On init we get the start values and trigger our coroutines for each property.
```

--------------------------------

### Initialization and Configuration Methods

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_top_down_engine_1_1_damage_on_touch.html

Methods for initializing the component, setting gizmo properties, and configuring knockback or damage directions.

```APIDOC
## Initialization()
Initializes ignore list, feedbacks, colliders and grabs components.

## InitializeFeedbacks()
Initializes feedbacks.

## SetGizmoSize(Vector3 newGizmoSize)
A public method letting you (re)define gizmo size.

## SetGizmoOffset(Vector3 newOffset)
A public method letting you specify a gizmo offset.

## SetKnockbackScriptDirection(Vector3 newDirection)
When knockback is in script direction mode, lets you specify the direction of the knockback.

## SetDamageScriptDirection(Vector3 newDirection)
When damage direction is in script mode, lets you specify the direction of damage.
```

--------------------------------

### StartListening

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_feedbacks_1_1_m_m_audio_filter_echo_shaker.html

Starts listening for audio filter echo shake events.

```APIDOC
## StartListening()

### Description
Registers the shaker to listen for incoming audio filter echo shake events.
```

--------------------------------

### DisableStartScreen()

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_top_down_engine_1_1_explodudes_start_screen.html

Disables the start screen. This method is intended to be called by an animator once the start screen animation has finished playing.

```APIDOC
## DisableStartScreen()

### Description
Called by an animator to turn the startscreen off after it plays.

### Signature
`virtual void DisableStartScreen()`
```

--------------------------------

### SetupInventorySoundPlayer

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_inventory_engine_1_1_inventory_sound_player.html

Initializes the inventory sound player component.

```APIDOC
## void SetupInventorySoundPlayer()

### Description
Initializes and sets up the inventory sound player for use.
```

--------------------------------

### Initialization

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_top_down_engine_1_1_button_activated.html

Initializes the component, grabs necessary references, and displays the interaction prompt if required.

```APIDOC
### void Initialization()

Initializes the component by grabbing required references and showing the interaction prompt if necessary.
```

--------------------------------

### Help()

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_tools_1_1_m_m_debug_menu_commands.html

Displays available commands.

```APIDOC
## void MoreMountains.Tools.MMDebugMenuCommands.Help()

### Description
Displays a list of all the commands.
```

--------------------------------

### SetupFeedbacks()

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_feedbacks_1_1_m_m_feedbacks_sequencer.html

Ensures the internal feedback array is correctly sized and configured.

```APIDOC
## SetupFeedbacks()

### Description
Ensures the internal array of feedbacks is always the correct length.
```

--------------------------------

### Capacity

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_tools_1_1_m_m_shufflebag-1-g.html

Gets the capacity of the shufflebag.

```APIDOC
## Capacity

### Description
Gets the total capacity of the shufflebag.
```

--------------------------------

### StartRecording()

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_feedbacks_1_1_m_m_input_sequence_recorder.html

Clears the sequence if necessary and begins the recording process.

```APIDOC
## StartRecording

### Description
Clears the sequence if needed and starts recording.
```

--------------------------------

### Initialization()

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_feedbacks_1_1_m_m_f___feedback.html

Initializes the feedback and its timing-related variables. Typically called during the Start phase.

```APIDOC
## Initialization()

### Description
Initializes the feedback and its timing related variables. Typically runs on Start.

### Signature
`virtual void Initialization(MMF_Player owner, int index)`

### Parameters
- **owner** (MMF_Player) - The MMF_Player instance that owns this feedback.
- **index** (int) - The index of the feedback.
```

--------------------------------

### Initialization()

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_tools_1_1_m_m_s_m_playlist.html

Initializes all songs within the playlist.

```APIDOC
### Method
`void Initialization()`

### Description
Initializes all songs associated with the playlist.
```

--------------------------------

### Initialization()

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_tools_1_1_m_m_s_m_playlist.html

Initializes all songs within the playlist.

```APIDOC
### Initialization()

Initializes all songs in the playlist. This should be called before starting playback.
```

--------------------------------

### SetupInventoryDisplay

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_inventory_engine_1_1_inventory_display.html

Creates and sets up the inventory display. This is typically invoked via the inspector's dedicated button.

```APIDOC
## virtual void SetupInventoryDisplay()

### Description
Creates and sets up the inventory display. Usually called via the inspector's dedicated button.
```

--------------------------------

### PlaySequence()

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_feedbacks_1_1_m_m_audio_source_sequencer.html

Starts the playback of the audio sequence.

```APIDOC
## PlaySequence()

### Description
Starts playing the sequence.
```

--------------------------------

### Size

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_tools_1_1_m_m_shufflebag-1-g.html

Gets the current size of the shufflebag.

```APIDOC
## Size

### Description
Gets the current number of items in the shufflebag.
```

--------------------------------

### Initialization()

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_top_down_engine_1_1_button_prompt.html

Initializes the button prompt component.

```APIDOC
### Initialization()

Initializes the button prompt component for use.
```

--------------------------------

### ShowWindow()

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_top_down_engine_1_1_welcome_window.html

Displays the TopDown Engine welcome window in the Unity Editor.

```APIDOC
## static void ShowWindow()

### Description
Opens the Welcome Window for the TopDown Engine within the Unity Editor environment.

### Signature
`void MoreMountains.TopDownEngine.WelcomeWindow.ShowWindow()`
```

--------------------------------

### CurrentValue

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_m_m_interface_1_1_m_m_sprite_replace.html

Gets the current state of the button.

```APIDOC
## CurrentValue

### Description
Returns a boolean representing the current state of the button (true for 'on', false for 'off').
```

--------------------------------

### StopStartFeedbacks()

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_top_down_engine_1_1_character_ability.html

Stops the start feedbacks associated with the ability.

```APIDOC
## virtual void StopStartFeedbacks()

### Description
Stops the ability used sound effect.
```

--------------------------------

### Initialization()

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_top_down_engine_1_1_a_i_action_set_last_known_position_as_target.html

Initializes the action by preparing a new game object to act as the target.

```APIDOC
## Initialization()

### Description
Prepares a new game object to act as the new target for the AI.

### Signature
`public override void Initialization()`
```

--------------------------------

### Initialization

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_feedbacks_1_1_m_m_f___player.html

Initializes the feedback player.

```APIDOC
## Initialization(bool forceInitIfPlaying = false)

### Description
Initializes the feedback player, setting up the necessary references for position and hierarchy.

### Parameters
- **forceInitIfPlaying** (bool) - Optional. If true, forces initialization even if feedbacks are currently playing.
```

--------------------------------

### StartShaking

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_feedbacks_1_1_m_m_camera_orthographic_size_shaker.html

Starts the shaking process for the orthographic size.

```APIDOC
## StartShaking

### Description
Initiates the shaking of the orthographic size values.
```

--------------------------------

### Initialization()

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_tools_1_1_m_m_follow_target.html

Initializes the follow component.

```APIDOC
### Initialization()

Initializes the follow component, preparing it to track the assigned target.
```

--------------------------------

### WeaponInputStart()

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_top_down_engine_1_1_weapon.html

Turns the weapon on when input is received.

```APIDOC
### Method
`virtual void WeaponInputStart()`

### Description
Called by input, turns the weapon on.
```

--------------------------------

### Initialization()

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_tools_1_1_m_m_audio_analyzer.html

Initializes the audio analyzer component.

```APIDOC
### Method
void Initialization()

### Description
Initializes the MMAudioAnalyzer, preparing it for audio sampling based on the configured mode and settings.
```

--------------------------------

### Initialization()

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_tools_1_1_m_m_audio_analyzer.html

Initializes the audio analyzer component.

```APIDOC
## Initialization()

### Description
Performs the necessary setup and initialization for the audio analyzer to function.

### Signature
`virtual void Initialization()`
```

--------------------------------

### Initialize and Use MMShufflebag

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_tools_1_1_m_m_shufflebag-1-g.html

Demonstrates how to instantiate the shufflebag, populate it with items, and retrieve them.

```csharp
var shuffleBag = new ShuffleBag(40); for (int i = 0; i<40; i++) { newValue = something; shuffleBag.Add(newValue, amount); }
then : float something = shuffleBag.Pick();
```

--------------------------------

### IsInstalled

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_top_down_engine_1_1_package_installation-members.html

Checks if a specific package is currently installed.

```APIDOC
## IsInstalled(string packageID)

### Description
Checks whether the package with the specified ID is installed.

### Parameters
- **packageID** (string) - The unique identifier for the package to check.
```

--------------------------------

### Get()

Source: https://topdown-engine-docs.moremountains.com/API/struct_more_mountains_1_1_top_down_engine_1_1_top_down_engine_input_actions_1_1_player_controls_actions.html

Retrieves the underlying input action map.

```APIDOC
### Method
InputActionMap Get()

### Description
Provides access to the underlying InputActionMap instance.
```

--------------------------------

### AutomaticShakerSetup()

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_feedbacks_for_third_party_1_1_m_m_f___color_adjustments___h_d_r_p.html

Automatically sets up the post-processing profile and shaker for the HDRP color adjustments feedback.

```APIDOC
## void AutomaticShakerSetup()

### Description
Automatically sets up the post processing profile and shaker for the feedback.
```

--------------------------------

### Get FeedbackDuration

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_feedbacks_1_1_m_m_f___t_m_p_softness.html

Retrieves the duration of the feedback transition.

```csharp
override float MoreMountains.Feedbacks.MMF_TMPSoftness.FeedbackDuration
```

--------------------------------

### Initialization()

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_top_down_engine_1_1_hitscan_weapon.html

Initializes the weapon instance.

```APIDOC
### void Initialization()

#### Description
Initializes the weapon. This method should be called to prepare the weapon for use.
```

--------------------------------

### GetGuid()

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_tools_1_1_m_m_persistent_base.html

Retrieves the current GUID assigned to the object.

```APIDOC
### Method
`virtual string GetGuid()`

### Description
Returns the object's GUID.

### Returns
- **string** - The object's GUID.
```

--------------------------------

### StartFollowing()

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_tools_1_1_m_m_follow_target.html

Resumes following the target.

```APIDOC
### StartFollowing()

Resumes the object's follow behavior towards the target.
```

--------------------------------

### ValidateGuid

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_tools_1_1_m_m_persistent_base.html

Ensures the object has a valid, unique GUID.

```APIDOC
### Method
void ValidateGuid()

### Description
Validates the current GUID and generates a new one if necessary until a unique one is found.
```

--------------------------------

### Initialization()

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_tools_1_1_m_m_animator_mirror.html

Initializes the mirroring process by caching animation parameter hashes for efficient lookup during updates.

```APIDOC
### Method
void Initialization()

### Description
Stores animation parameter hashes to prepare the mirror component for runtime synchronization.
```

--------------------------------

### GuidIsUnique

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_tools_1_1_m_m_persistent_base.html

Checks if a provided GUID is currently unique.

```APIDOC
### Method
bool GuidIsUnique(string guid)

### Parameters
- **guid** (string) - The GUID to check.
```

--------------------------------

### SetGuid

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_tools_1_1_m_m_persistent_base.html

Manually sets the GUID for the persistent object.

```APIDOC
### Method
void SetGuid(string newGUID)

### Parameters
- **newGUID** (string) - The new GUID to assign to the object.
```

--------------------------------

### AutomaticShakerSetup()

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_feedbacks_1_1_m_m_f___camera_shake.html

Automatically attempts to add a camera rig if none are currently present in the scene.

```APIDOC
## void AutomaticShakerSetup()

### Description
Automatically tries to add a camera rig if none are present.
```

--------------------------------

### Initialization()

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_tools_1_1_m_m_property_link_quaternion.html

Initializes the property link.

```APIDOC
## Initialization()

### Description
Initializes the property link by grabbing the initial state.

### Parameters
- **property** (MMProperty) - The property to initialize.
```

--------------------------------

### InitialValue Property

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_tools_1_1_float_controller.html

Represents the starting value of the controlled float.

```csharp
float MoreMountains.Tools.FloatController.InitialValue
```

--------------------------------

### CaseWeaponStart()

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_top_down_engine_1_1_weapon.html

Handles the initial state when a weapon is activated.

```APIDOC
## virtual void CaseWeaponStart()

### Description
When the weapon starts we switch to a delay or shoot based on our weapon's settings.
```

--------------------------------

### Initialization()

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_feedbacks_1_1_m_m_input_sequence_recorder.html

Initializes the recorder and ensures a valid ScriptableObject is assigned for recording.

```APIDOC
## Initialization()

### Description
Makes sure we have a scriptable object to record to.
```

--------------------------------

### LoadSettings()

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_tools_1_1_m_m_sound_manager.html

Loads sound settings from a file.

```APIDOC
## LoadSettings()

### Description
Loads sound settings from file.
```

--------------------------------

### TargetExists()

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_feedbacks_1_1_m_m_f___feedback.html

Checks whether a feedback has a correct target setup or not.

```APIDOC
## bool TargetExists(UnityEngine.Object target, string targetName)

### Description
Checks whether a feedback has a correct target setup or not.

### Parameters
- **target** (UnityEngine.Object) - The target object to validate.
- **targetName** (string) - The name of the target to validate.
```

--------------------------------

### Initialization

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_tools_1_1_float_controller.html

Initializes the controller and prepares the target property for manipulation.

```APIDOC
### Initialization

#### Method
`void Initialization()`

#### Description
Grabs the target property and initializes internal settings.
```

--------------------------------

### CurrentIndex Property

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_tools_1_1_m_m_circular_list-1-g.html

Gets or sets the current index of the list.

```APIDOC
## int CurrentIndex

### Description
Allows setting the current index or computing it when retrieved.
```

--------------------------------

### JumpStart()

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_top_down_engine_1_1_character_jump3_d.html

Initiates the jump action for the character, transitioning the state to jumping.

```APIDOC
### Method
`virtual void JumpStart()`

### Description
Changes the character's state to jumping to initiate the jump movement.
```

--------------------------------

### Initialization()

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_feedbacks_1_1_m_m_input_sequence_recorder.html

Initializes the recorder and ensures a scriptable object is available for recording.

```APIDOC
## Initialization

### Description
Makes sure we have a scriptable object to record to.
```

--------------------------------

### CurrentSwitchState

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_m_m_interface_1_1_m_m_switch.html

Property to get or set the current state of the switch.

```APIDOC
## Property: CurrentSwitchState

### Description
The current state of the switch (Left or Right).

### Signature
`public SwitchStates CurrentSwitchState { get; set; }`
```

--------------------------------

### FeedbackDuration

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_feedbacks_1_1_m_m_f___floating_text.html

Gets or sets the duration of the floating text feedback.

```APIDOC
## Property: FeedbackDuration

### Description
Gets or sets the duration of this feedback, which is either a fixed value or the lifetime of the feedback. This property also sets the inspector color for the feedback.

### Type
float
```

--------------------------------

### Register

Source: https://topdown-engine-docs.moremountains.com/API/struct_more_mountains_1_1_tools_1_1_m_m_playlist_new_song_started_event.html

Registers a callback delegate to be invoked when a new song starts.

```APIDOC
### static void Register(Delegate callback)

Registers a method to be called when the MMPlaylistNewSongStartedEvent is triggered.

#### Parameters
- **callback** (Delegate) - The method to execute when the event occurs.
```

--------------------------------

### OnStateEnter

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_tools_1_1_m_m_animation_modifier.html

Modifies the animation speed and start position when the state is entered.

```APIDOC
## OnStateEnter

### Description
On state enter, we modify our speed and start position.

### Signature
`void OnStateEnter(Animator animator, AnimatorStateInfo stateInfo, int layerIndex)`

### Parameters
- **animator** (Animator) - The animator component.
- **stateInfo** (AnimatorStateInfo) - The state information.
- **layerIndex** (int) - The layer index.
```

--------------------------------

### Initialization()

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_top_down_engine_1_1_a_i_decision_detect_target_cone_of_vision2_d.html

Initializes the decision component by retrieving the required MMConeOfVision reference.

```APIDOC
### Method
`override void Initialization()`

### Description
Initializes the component and grabs the reference to the MMConeOfVision. Reimplemented from MoreMountains.Tools.AIDecision.
```

--------------------------------

### Initialization()

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_top_down_engine_1_1_a_i_action_invert_patrol_direction.html

Initializes the action by grabbing the necessary patrol components.

```APIDOC
## Initialization()

### Description
Initializes the action by grabbing the necessary patrol components. This method is called during the AI setup phase.

### Signature
`public override void Initialization()`
```

--------------------------------

### Initialization()

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_tools_1_1_m_m_path.html

Initializes the path, including movement determination and object positioning.

```APIDOC
## Initialization()

### Description
Handles flag initialization, initial movement determination, and object positioning.
```

--------------------------------

### CurrentGridPosition

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_top_down_engine_1_1_character_grid_movement.html

A virtual property to get the current grid coordinates of the character.

```APIDOC
## Property: CurrentGridPosition

### Description
Returns the current position of the object on the grid.

### Type
Vector3Int

### Access
get; protected set;
```

--------------------------------

### Initialization

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_tools_1_1_m_m_path.html

Initializes the path, determines initial movement, and positions the object.

```APIDOC
## Initialization()

### Description
Flag inits, initial movement determination, and object positioning.
```

--------------------------------

### Initialization()

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_top_down_engine_1_1_combo_weapon.html

Initializes the ComboWeapon by grabbing all associated Weapon components.

```APIDOC
## Initialization()

### Description
Grabs all Weapon components attached to the object and initializes them for use in the combo system.

### Signature
`public virtual void Initialization()`
```

--------------------------------

### TargetCanvas

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_tools_1_1_m_m_u_i_follow_mouse.html

Gets or sets the target Canvas that the UI element is associated with.

```APIDOC
## Property: TargetCanvas

### Description
Gets or sets the Canvas component that the UI element follows the mouse within.

### Type
Canvas
```

--------------------------------

### GuidIsUnique()

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_tools_1_1_m_m_persistent_base.html

Checks if a provided GUID is unique within the current context.

```APIDOC
### Method
`virtual bool GuidIsUnique(string guid)`

### Description
Checks if the object's ID is unique or not.

### Parameters
- **guid** (string) - The GUID to check.

### Returns
- **bool** - True if the GUID is unique, false otherwise.
```

--------------------------------

### Show()

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_top_down_engine_1_1_button_prompt.html

Displays the button prompt.

```APIDOC
### Show()

Makes the button prompt visible.
```

--------------------------------

### OnPause

Source: https://topdown-engine-docs.moremountains.com/API/interface_more_mountains_1_1_top_down_engine_1_1_top_down_engine_input_actions_1_1_i_player_controls_actions.html

Method invoked when the 'Pause' input action is started, performed, or canceled.

```APIDOC
## void OnPause(InputAction.CallbackContext context)

### Description
Method invoked when associated input action "Pause" is either UnityEngine.InputSystem.InputAction.started, UnityEngine.InputSystem.InputAction.performed or UnityEngine.InputSystem.InputAction.canceled.

### Parameters
- **context** (InputAction.CallbackContext) - The context of the input action.
```

--------------------------------

### Show()

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_top_down_engine_1_1_button_prompt.html

Displays the button prompt.

```APIDOC
## Show()

### Description
Displays the button prompt.
```

--------------------------------

### OnJump

Source: https://topdown-engine-docs.moremountains.com/API/interface_more_mountains_1_1_top_down_engine_1_1_top_down_engine_input_actions_1_1_i_player_controls_actions.html

Method invoked when the 'Jump' input action is started, performed, or canceled.

```APIDOC
## void OnJump(InputAction.CallbackContext context)

### Description
Method invoked when associated input action "Jump" is either UnityEngine.InputSystem.InputAction.started, UnityEngine.InputSystem.InputAction.performed or UnityEngine.InputSystem.InputAction.canceled.

### Parameters
- **context** (InputAction.CallbackContext) - The context of the input action.
```

--------------------------------

### StartFollowing

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_top_down_engine_1_1_magnetic.html

Enables the object to follow the target.

```APIDOC
## StartFollowing()

### Description
Makes the object follow the target.
```

--------------------------------

### OnInteract

Source: https://topdown-engine-docs.moremountains.com/API/interface_more_mountains_1_1_top_down_engine_1_1_top_down_engine_input_actions_1_1_i_player_controls_actions.html

Method invoked when the 'Interact' input action is started, performed, or canceled.

```APIDOC
## void OnInteract(InputAction.CallbackContext context)

### Description
Method invoked when associated input action "Interact" is either UnityEngine.InputSystem.InputAction.started, UnityEngine.InputSystem.InputAction.performed or UnityEngine.InputSystem.InputAction.canceled.

### Parameters
- **context** (InputAction.CallbackContext) - The context of the input action.
```

--------------------------------

### OnDash

Source: https://topdown-engine-docs.moremountains.com/API/interface_more_mountains_1_1_top_down_engine_1_1_top_down_engine_input_actions_1_1_i_player_controls_actions.html

Invoked when the Dash input action is triggered (started, performed, or canceled).

```APIDOC
### Method
void OnDash(InputAction.CallbackContext context)

### Description
Method invoked when associated input action "Dash" is either UnityEngine.InputSystem.InputAction.started, UnityEngine.InputSystem.InputAction.performed or UnityEngine.InputSystem.InputAction.canceled.
```

--------------------------------

### OnCrouch

Source: https://topdown-engine-docs.moremountains.com/API/interface_more_mountains_1_1_top_down_engine_1_1_top_down_engine_input_actions_1_1_i_player_controls_actions.html

Invoked when the Crouch input action is triggered (started, performed, or canceled).

```APIDOC
### Method
void OnCrouch(InputAction.CallbackContext context)

### Description
Method invoked when associated input action "Crouch" is either UnityEngine.InputSystem.InputAction.started, UnityEngine.InputSystem.InputAction.performed or UnityEngine.InputSystem.InputAction.canceled.
```

--------------------------------

### OnCameraRotation

Source: https://topdown-engine-docs.moremountains.com/API/interface_more_mountains_1_1_top_down_engine_1_1_top_down_engine_input_actions_1_1_i_player_controls_actions.html

Invoked when the CameraRotation input action is triggered (started, performed, or canceled).

```APIDOC
### Method
void OnCameraRotation(InputAction.CallbackContext context)

### Description
Method invoked when associated input action "CameraRotation" is either UnityEngine.InputSystem.InputAction.started, UnityEngine.InputSystem.InputAction.performed or UnityEngine.InputSystem.InputAction.canceled.
```

--------------------------------

### ButtonPressed()

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_top_down_engine_1_1_start_screen.html

Triggers the logic associated with the main button press on the start screen.

```APIDOC
## void ButtonPressed()

### Description
Defines the behavior executed when the main button on the start screen is pressed.
```

--------------------------------

### WeaponStarted

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_top_down_engine_1_1_combo_weapon.html

Handles the event when a weapon in the combo starts, disabling the combo countdown.

```APIDOC
### WeaponStarted

**Signature:** `virtual void WeaponStarted(Weapon weaponThatStarted)`

When one of the weapons get used we turn our countdown off.
```

--------------------------------

### Play

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_tools_1_1_m_m_s_m_playlist_manager.html

Starts playing the first song of the playlist or resumes playback after a pause.

```APIDOC
## Play()

### Description
Use this method to either play the first song of the playlist, or resume after a pause.
```

--------------------------------

### AutomaticShakerSetup()

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_feedbacks_for_third_party_1_1_m_m_f___bloom.html

Automatically sets up the post-processing profile and shaker for the bloom effect.

```APIDOC
### void AutomaticShakerSetup()

#### Description
Automatically sets up the post-processing profile and shaker associated with this bloom feedback.
```

--------------------------------

### Initialization()

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_top_down_engine_1_1_a_i_action_dash.html

Initializes the AIActionDash by retrieving and setting up the required dash ability.

```APIDOC
## Initialization()

### Description
On initialization, this method grabs the character's dash ability and automatically sets it up if necessary.

### Signature
`public override void Initialization()`
```

--------------------------------

### AutomaticShakerSetup()

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_feedbacks_1_1_m_m_f___sound.html

Attempts to automatically add an MMSoundManager to the scene if one is missing.

```APIDOC
### AutomaticShakerSetup()

Automatically attempts to initialize the MMSoundManager in the scene. This is a virtual method that overrides the base feedback implementation.
```

--------------------------------

### HasAutomaticShakerSetup

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_feedbacks_1_1_m_m_f___player.html

Checks if any feedbacks within the player are configured for automatic shaker setup.

```APIDOC
### Property: HasAutomaticShakerSetup

**Type**: bool

**Description**: Returns true if one or more feedbacks on this MMF_Player have an option for automatic shaker setup, otherwise returns false.
```

--------------------------------

### Initialization

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_top_down_engine_1_1_weapon.html

Methods for initializing the weapon and setting its owner.

```APIDOC
### void Initialization()
Initializes the weapon.

### void SetOwner(Character newOwner, CharacterHandleWeapon handleWeapon)
Sets the weapon's owner and the associated handle weapon component.
```

--------------------------------

### InButtonAutoActivatedZone

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_top_down_engine_1_1_character_button_activation.html

Gets or sets whether the current zone is an automated button-activated zone.

```APIDOC
## Property: InButtonAutoActivatedZone

### Description
Returns true if the zone is automated.

### Type
bool
```

--------------------------------

### Initialization()

Source: https://topdown-engine-docs.moremountains.com/API/class_more_mountains_1_1_tools_1_1_m_m_playlist_song.html

Initializes the MMPlaylistSong instance. This method should be called to prepare the song for playback.

```APIDOC
### Initialization()

#### Description
Initializes the MMPlaylistSong instance, preparing the audio source and settings for playback.

#### Signature
`virtual void Initialization()`
```
Tokens:
Raw