Class GameSettingsManager

This manager persists through lobby and in-game acting as a run settings storage.

Inheritance
object
UnityEngine.Object
UnityEngine.Component
UnityEngine.Behaviour
UnityEngine.MonoBehaviour
Mirror.NetworkBehaviour
DewNetworkBehaviour
NetworkedManagerBase<GameSettingsManager>
GameSettingsManager
Implements
Inherited Members
Namespace: Global
Assembly: Dew.Core.dll
Syntax
public class GameSettingsManager : NetworkedManagerBase<GameSettingsManager>, ILogicUpdate

Fields

activeLucidDreams

Declaration
[SaveVar(SaveVarFlags.Default)]
public readonly SyncList<string> activeLucidDreams
Field Value
Type Description
Mirror.SyncList<T><string>

addedGameMods

This should not be changed after starting the server.

Declaration
[SaveVar(SaveVarFlags.Default)]
public readonly SyncList<string> addedGameMods
Field Value
Type Description
Mirror.SyncList<T><string>

availableLucidDreams

Declaration
[SaveVar(SaveVarFlags.Default)]
public readonly SyncList<string> availableLucidDreams
Field Value
Type Description
Mirror.SyncList<T><string>

bannedGameItems

Declaration
[SaveVar(SaveVarFlags.Default)]
public readonly SyncList<string> bannedGameItems
Field Value
Type Description
Mirror.SyncList<T><string>

ClientEvent_OnActiveLucidDreamsChanged

Declaration
public SafeAction ClientEvent_OnActiveLucidDreamsChanged
Field Value
Type Description
SafeAction

ClientEvent_OnAvailableLucidDreamsChanged

Declaration
public SafeAction ClientEvent_OnAvailableLucidDreamsChanged
Field Value
Type Description
SafeAction

ClientEvent_OnBannedItemsChanged

Declaration
public SafeAction ClientEvent_OnBannedItemsChanged
Field Value
Type Description
SafeAction

ClientEvent_OnCustomDataChanged

Declaration
public SafeAction<string> ClientEvent_OnCustomDataChanged
Field Value
Type Description
SafeAction<string>

ClientEvent_OnDifficultyChanged

Declaration
public SafeAction<string, string> ClientEvent_OnDifficultyChanged
Field Value
Type Description
SafeAction<string, string>

ClientEvent_OnLobbyTagsChanged

Declaration
public SafeAction ClientEvent_OnLobbyTagsChanged
Field Value
Type Description
SafeAction

ClientEvent_OnStateChanged

Declaration
public SafeAction ClientEvent_OnStateChanged
Field Value
Type Description
SafeAction

ClientEvent_OnUnlockedGameItemsChanged

Declaration
public SafeAction ClientEvent_OnUnlockedGameItemsChanged
Field Value
Type Description
SafeAction

customData

Declaration
[SaveVar(SaveVarFlags.Default)]
public readonly SyncDictionary<string, string> customData
Field Value
Type Description
Mirror.SyncDictionary<TKey, TValue><string, string>

lobbyTags

Declaration
[SaveVar(SaveVarFlags.Default)]
public readonly SyncList<string> lobbyTags
Field Value
Type Description
Mirror.SyncList<T><string>

localPlayerDejavuCost

Declaration
public int localPlayerDejavuCost
Field Value
Type Description
int

unlockedGameItems

Declaration
[SaveVar(SaveVarFlags.Default)]
public readonly SyncList<string> unlockedGameItems
Field Value
Type Description
Mirror.SyncList<T><string>

Properties

allowDejavu

Declaration
[SaveVar(SaveVarFlags.Default)]
public bool allowDejavu { get; set; }
Property Value
Type Description
bool

allowMidJoins

Declaration
[SaveVar(SaveVarFlags.Default)]
public AllowMidJoinType allowMidJoins { get; set; }
Property Value
Type Description
AllowMidJoinType

difficulty

Declaration
[SaveVar(SaveVarFlags.Default)]
public string difficulty { get; set; }
Property Value
Type Description
string

enableVotes

Declaration
[SaveVar(SaveVarFlags.Default)]
public bool enableVotes { get; set; }
Property Value
Type Description
bool

gameSettingsSaveKey

Declaration
[SaveVar(SaveVarFlags.Default)]
public string gameSettingsSaveKey { get; set; }
Property Value
Type Description
string

lobbyDescription

Declaration
[SaveVar(SaveVarFlags.Default)]
public string lobbyDescription { get; set; }
Property Value
Type Description
string

lobbyName

Declaration
[SaveVar(SaveVarFlags.Default)]
public string lobbyName { get; set; }
Property Value
Type Description
string

maxPlayers

Declaration
[SaveVar(SaveVarFlags.Default)]
public int maxPlayers { get; set; }
Property Value
Type Description
int

midJoinBanType

This is irreversible by design.

Declaration
[SaveVar(SaveVarFlags.Default)]
public MidJoinBanType midJoinBanType { get; set; }
Property Value
Type Description
MidJoinBanType

midJoinWaitType

This should be set and unset accordingly mid-run.

Declaration
public MidJoinWaitType midJoinWaitType { get; set; }
Property Value
Type Description
MidJoinWaitType

state

Declaration
public GameState state { get; set; }
Property Value
Type Description
GameState

Methods

AddLucidDream(string)

Declaration
public void AddLucidDream(string type)
Parameters
Type Name Description
string type

Awake()

Declaration
protected override void Awake()
Overrides
NetworkedManagerBase<GameSettingsManager>.Awake()

ClearLucidDreams()

Declaration
public void ClearLucidDreams()

DisconnectByMidJoinBan()

Declaration
public void DisconnectByMidJoinBan()

DisconnectByMidJoinWaitBlock()

Declaration
public void DisconnectByMidJoinWaitBlock()

GetLocalPreferredGameSettings()

Declaration
public PreferredGameSettings GetLocalPreferredGameSettings()
Returns
Type Description
PreferredGameSettings

Lobby_UpdateAttribute(string)

Declaration
public UniTask Lobby_UpdateAttribute(string key)
Parameters
Type Name Description
string key
Returns
Type Description
Cysharp.Threading.Tasks.UniTask

Lobby_UpdateCanJoinAndGameStarted(bool?)

Declaration
public UniTask Lobby_UpdateCanJoinAndGameStarted(bool? hasGameStartedOverride = null)
Parameters
Type Name Description
bool? hasGameStartedOverride
Returns
Type Description
Cysharp.Threading.Tasks.UniTask

Lobby_UpdateGameAttributes()

Declaration
public UniTask Lobby_UpdateGameAttributes()
Returns
Type Description
Cysharp.Threading.Tasks.UniTask

Lobby_UpdateGameStartTimestamp()

Declaration
public UniTask Lobby_UpdateGameStartTimestamp()
Returns
Type Description
Cysharp.Threading.Tasks.UniTask

LogicUpdate(float)

Declaration
public override void LogicUpdate(float dt)
Parameters
Type Name Description
float dt
Overrides

OnStartClient()

Declaration
public override void OnStartClient()
Overrides
NetworkedManagerBase<GameSettingsManager>.OnStartClient()

OnStartServer()

Declaration
public override void OnStartServer()
Overrides

OnStopServer()

Declaration
public override void OnStopServer()
Overrides

RemoveLucidDream(string)

Declaration
public void RemoveLucidDream(string type)
Parameters
Type Name Description
string type

SetEnableVotes(bool)

Declaration
public void SetEnableVotes(bool value)
Parameters
Type Name Description
bool value

UpdateAvailableLucidDreams()

Declaration
public void UpdateAvailableLucidDreams()

ValidateBannedItems(bool)

Declaration
public void ValidateBannedItems(bool printMessage)
Parameters
Type Name Description
bool printMessage

Implements

Extension Methods