Heroic Engine
  • Welcome
  • Getting Started
    • Quickstart
    • Example Games
      • Tic Tac Toe
      • Turn based duel
  • Basics
    • Injection Manager
    • Engine Systems
      • Core Systems
        • Events Manager
        • Input Manager
        • Localization Manager
          • LangText component
        • Music Player
        • Sounds Manager
        • Time Manager
        • Scenes Loader
        • Day Time Controller
        • Weather Controller
      • Gameplay Systems
        • Currencies Manager
        • Player Progression Manager
        • Quest Manager
        • Random Events Manager
        • Hittables Manager
        • Dungeon Generator
      • UI Systems
        • UI Controller
        • Countdown Controller
    • Editor Tools
      • Clear Saves
      • Mobile Build Optimizer
      • Create System
      • Icon from Prefab Generator
    • Engine Utilities
      • PoolSystem
      • DataSaver
      • ComponentExtensions
      • MaterialExtensions
      • SpriteUtils
      • SlowUpdate
      • StringUtils
      • TypeUtility
      • MathHelper
      • VectorUtils
      • TransformUtils
      • MeshUtils
    • Useful Components
      • Floating Item
      • Fly Up Text
      • Label Scaler
      • Ragdoll
      • Rotate To Camera
      • Orbital Camera
      • Rotator
      • Texture Mover
      • Hittable
      • Projectile
      • Projectile2D
      • LifetimeObject
      • Spawner
      • Colorized Particles
      • Draggable2D
      • SaveableTransform
    • Useful Attributes
Powered by GitBook
On this page
  • Parameters in inspector
  • Available methods
  1. Basics
  2. Engine Systems
  3. Core Systems

Music Player

This system is able to play music tracks in random order without repeats if its possible.

To use this system, inject MusicPlayer class into your class, as shown below:

[Inject] private MusicPlayer musicPlayer;

Parameters in inspector

musicSource – AudioSouce used by Music Player system. By default, there is already presented AudioSource inside the MusicPlayer GameObject on scene.

musicClips – list of music clips, categorized by music entry types.

delayBetweenClips – time delay between music clips, 3 seconds by default.

Available methods

void Play(MusicEntryType entryType)

This method plays random music clip by certain entryType.

MusicEntryType enum has next possible values by default: MusicEntryType.MainMenu, MusicEntryType.InGame, MusicEntryType.VictoryScreen and MusicEntryType.LossScreen. But you can extend this list as you wish.

Example:

musicPlayer.Play(MusicPlayer.MusicEntryType.MainMenu);

void Stop()

This method stops currently playing music.

Example:

musicPlayer.Stop();
PreviousLangText componentNextSounds Manager

Last updated 5 months ago