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

A generic level manager meant to handle multiplayer scenes (specifically spawn and camera modes It's recommended to extend it to implement your own specific gameplay rules. More...

Inheritance diagram for MoreMountains.TopDownEngine.MultiplayerLevelManager:
MoreMountains.TopDownEngine.LevelManager MoreMountains.Tools.MMSingleton< T > MoreMountains.Tools.MMEventListener< T > MoreMountains.Tools.MMEventListenerBase MoreMountains.TopDownEngine.ExplodudesMultiplayerLevelManager MoreMountains.TopDownEngine.GrasslandsMultiplayerLevelManager

Public Types

enum  CameraModes { Split , Group }
 the types of cameras to choose from More...

Public Member Functions

override void PlayerDead (Character playerCharacter)
 Kills the specified player.
Public Member Functions inherited from MoreMountains.TopDownEngine.LevelManager
virtual void GotoLevel (string levelName)
 Gets the player to the specified level.
virtual void TriggerEndLevelEvents ()
 Triggers end of level events.
virtual void ToggleCharacterPause ()
 Toggles Character Pause.
virtual void FreezeCharacters ()
 Freezes the character(s)
virtual void UnFreezeCharacters ()
 Unfreezes the character(s)
virtual void SetCurrentCheckpoint (CheckPoint newCheckPoint)
 Sets the current checkpoint with the one set in parameter. This checkpoint will be saved and used should the player die.
virtual void OnMMEvent (TopDownEngineEvent engineEvent)
 Catches TopDownEngineEvents and acts on them, playing the corresponding sounds.
Public Member Functions inherited from MoreMountains.Tools.MMEventListener< T >
void OnMMEvent (T eventType)

Public Attributes

List< CheckPointSpawnPoints
 the list of checkpoints (in order) to use to spawn characters
CameraModes CameraMode = CameraModes.Split
 the selected camera mode (either group, all targets in one screen, or split screen)
GameObject GroupCameraRig
 the group camera rig
GameObject SplitCameraRig
 the split camera rig
MultiplayerGUIManager MPGUIManager
 the multiplayer GUI Manager
Public Attributes inherited from MoreMountains.TopDownEngine.LevelManager
bool AutoAttributePlayerIDs = true
 the prefab you want for your player
Character[] PlayerPrefabs
 the list of player prefabs to instantiate
List< CharacterSceneCharacters
 a list of Characters already present in the scene before runtime. If this list is filled, PlayerPrefabs will be ignored
CheckPoint InitialSpawnPoint
 the checkpoint to use as initial spawn point if no point of entry is specified
CheckPoint CurrentCheckpoint
 the currently active checkpoint (the last checkpoint passed by the player)
Transform[] PointsOfEntry
 A list of this level's points of entry, which can be used from other levels as initial targets.
float IntroFadeDuration =1f
 duration of the initial fade in (in seconds)
float SpawnDelay = 0f
float OutroFadeDuration =1f
 duration of the fade to black at the end of the level (in seconds)
int FaderID = 0
 the ID to use when triggering the event (should match the ID on the fader you want to use)
MMTweenType FadeCurve = new MMTweenType(MMTween.MMTweenCurve.EaseInOutCubic)
 the curve to use for in and out fades
float RespawnDelay = 2f
 duration between a death of the main character and its respawn
float DelayBeforeDeathScreen = 1f
 the delay, in seconds, before displaying the death screen once the player is dead
bool UseLevelBounds = true
 if this is true, this level will use the level bounds defined on this LevelManager. Set it to false when using the Rooms system.
MMLoadScene.LoadingSceneModes LoadingSceneMode = MMLoadScene.LoadingSceneModes.MMSceneLoadingManager
 the method to use to load the destination level
string LoadingSceneName = "LoadingScreen"
 the name of the MMSceneLoadingManager scene you want to use
MMAdditiveSceneLoadingManagerSettings AdditiveLoadingSettings
 the settings to use when loading the scene in additive mode
bool SetPlayerAsFeedbackRangeCenter = false
 if this is true, an event will be triggered on player instantiation to set the range target of all feedbacks to it

Protected Member Functions

override void Awake ()
 On awake we handle our different camera modes.
virtual void HandleCameraModes ()
 Sets up the scene to match the selected camera mode.
override void SpawnMultipleCharacters ()
 Spawns all characters at the specified spawn points.
virtual void OnPlayerDeath (Character playerCharacter)
 Override this to specify what happens when a player dies.
Protected Member Functions inherited from MoreMountains.TopDownEngine.LevelManager
virtual void Start ()
 On Start we grab our dependencies and initialize spawn.
virtual IEnumerator InitializationCoroutine ()
virtual void InstantiatePlayableCharacters ()
 Instantiate playable characters based on the ones specified in the PlayerPrefabs list in the LevelManager's inspector.
virtual void CheckpointAssignment ()
 Assigns all respawnable objects in the scene to their checkpoint.
virtual void Initialization ()
 Gets current camera, points number, start time, etc.
virtual void SpawnSingleCharacter ()
 Spawns a playable character into the scene.
virtual IEnumerator GotoLevelCo (string levelName)
 Waits for a short time and then loads the specified level.
virtual IEnumerator PlayerDeadCo ()
 Triggers the death screen display after a short delay.
virtual void Respawn ()
 Initiates the respawn.
virtual IEnumerator SoloModeRestart ()
 Coroutine that kills the player, stops the camera, resets the points.
virtual void OnEnable ()
 OnDisable, we start listening to events.
virtual void OnDisable ()
 OnDisable, we stop listening to events.
Protected Member Functions inherited from MoreMountains.Tools.MMSingleton< T >
virtual void InitializeSingleton ()
 Initializes the singleton.

Additional Inherited Members

Static Public Member Functions inherited from MoreMountains.Tools.MMSingleton< T >
static T TryGetInstance ()
Static Protected Member Functions inherited from MoreMountains.TopDownEngine.LevelManager
static void InitializeStatics ()
 Statics initialization to support enter play modes.
Protected Attributes inherited from MoreMountains.TopDownEngine.LevelManager
DateTime _started
int _savedPoints
Collider _collider
Collider2D _collider2D
Vector3 _initialSpawnPointPosition
Static Protected Attributes inherited from MoreMountains.Tools.MMSingleton< T >
static T _instance
Properties inherited from MoreMountains.TopDownEngine.LevelManager
virtual Bounds LevelBounds [get]
 the level limits, camera and player won't go beyond this point.
virtual Collider BoundsCollider [get, protected set]
virtual Collider2D BoundsCollider2D [get, protected set]
virtual TimeSpan RunningTime [get]
 the elapsed time since the start of the level
virtual List< CheckPointCheckpoints [get, protected set]
virtual List< CharacterPlayers [get, protected set]
Properties inherited from MoreMountains.Tools.MMSingleton< T >
static bool HasInstance [get]
static T Current [get]
static T Instance [get]
 Singleton design pattern.

Detailed Description

A generic level manager meant to handle multiplayer scenes (specifically spawn and camera modes It's recommended to extend it to implement your own specific gameplay rules.

Member Enumeration Documentation

◆ CameraModes

the types of cameras to choose from

Enumerator
Split 
Group 

Member Function Documentation

◆ Awake()

override void MoreMountains.TopDownEngine.MultiplayerLevelManager.Awake ( )
protectedvirtual

On awake we handle our different camera modes.

Reimplemented from MoreMountains.TopDownEngine.LevelManager.

◆ HandleCameraModes()

virtual void MoreMountains.TopDownEngine.MultiplayerLevelManager.HandleCameraModes ( )
protectedvirtual

Sets up the scene to match the selected camera mode.

◆ OnPlayerDeath()

virtual void MoreMountains.TopDownEngine.MultiplayerLevelManager.OnPlayerDeath ( Character playerCharacter)
protectedvirtual

Override this to specify what happens when a player dies.

Parameters
playerCharacter

Reimplemented in MoreMountains.TopDownEngine.ExplodudesMultiplayerLevelManager, and MoreMountains.TopDownEngine.GrasslandsMultiplayerLevelManager.

◆ PlayerDead()

override void MoreMountains.TopDownEngine.MultiplayerLevelManager.PlayerDead ( Character playerCharacter)
virtual

Kills the specified player.

Reimplemented from MoreMountains.TopDownEngine.LevelManager.

◆ SpawnMultipleCharacters()

override void MoreMountains.TopDownEngine.MultiplayerLevelManager.SpawnMultipleCharacters ( )
protectedvirtual

Spawns all characters at the specified spawn points.

Reimplemented from MoreMountains.TopDownEngine.LevelManager.

Member Data Documentation

◆ CameraMode

CameraModes MoreMountains.TopDownEngine.MultiplayerLevelManager.CameraMode = CameraModes.Split

the selected camera mode (either group, all targets in one screen, or split screen)

◆ GroupCameraRig

GameObject MoreMountains.TopDownEngine.MultiplayerLevelManager.GroupCameraRig

the group camera rig

◆ MPGUIManager

MultiplayerGUIManager MoreMountains.TopDownEngine.MultiplayerLevelManager.MPGUIManager

the multiplayer GUI Manager

◆ SpawnPoints

List<CheckPoint> MoreMountains.TopDownEngine.MultiplayerLevelManager.SpawnPoints

the list of checkpoints (in order) to use to spawn characters

◆ SplitCameraRig

GameObject MoreMountains.TopDownEngine.MultiplayerLevelManager.SplitCameraRig

the split camera rig


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