Interface IGameModeSettingsDefinition
Settings definition interface for the Game Mode system.
Namespace: Serenity.GameMode.Domain.Interfaces
Assembly: Serenity.GameMode.Domain.dll
Syntax
public interface IGameModeSettingsDefinition : IFoundationSettingsRemarks
This interface extends IFoundationSettings to include game mode-specific configuration.
Properties
GameActionMapName
The name of the action map used during gameplay.
Declaration
string GameActionMapName { get; }Property Value
| Type | Description |
|---|---|
| string |
MenuActionMapName
The name of the action map used during menu navigation.
Declaration
string MenuActionMapName { get; }Property Value
| Type | Description |
|---|---|
| string |
PauseAffectsTimeScale
Whether entering pause mode affects Time.timeScale.
Declaration
bool PauseAffectsTimeScale { get; }Property Value
| Type | Description |
|---|---|
| bool |
PauseDuringSceneLoad
Whether the game clock is paused while the gameplay scene is loading, and resumed once the load completes.
Declaration
bool PauseDuringSceneLoad { get; }Property Value
| Type | Description |
|---|---|
| bool |
PauseMenuId
The menu ID to display when pausing the game.
Declaration
string PauseMenuId { get; }Property Value
| Type | Description |
|---|---|
| string |
Methods
GetExitSignalsForGameMode(GameMode)
Gets the signals to dispatch when the specified GameMode is exited.
Declaration
IReadOnlyList<EventDispatcherSignal> GetExitSignalsForGameMode(GameMode mode)Parameters
| Type | Name | Description |
|---|---|---|
| GameMode | mode | The game mode being left whose configured exit signals should be returned. |
Returns
| Type | Description |
|---|---|
| IReadOnlyList<EventDispatcherSignal> | A read-only list of event dispatcher signals fired on transition away from |
GetSignalsForGameMode(GameMode)
Gets the signals to dispatch when the specified GameMode is entered.
Declaration
IReadOnlyList<EventDispatcherSignal> GetSignalsForGameMode(GameMode mode)Parameters
| Type | Name | Description |
|---|---|---|
| GameMode | mode | The target game mode whose configured signals should be returned. |
Returns
| Type | Description |
|---|---|
| IReadOnlyList<EventDispatcherSignal> | A read-only list of event dispatcher signals fired on transition to |