Skip to content

Class: GameSettingsManager ​

csharp
public class GameSettingsManager : NetworkedManagerBase<GameSettingsManager>, ILogicUpdate

Fields ​

NameDeclarationDescription
activeLucidDreams`[SaveVar(SaveVarFlags.Default)]
public readonly SyncList<string> activeLucidDreams`
addedGameMods`[SaveVar(SaveVarFlags.Default)]
public readonly SyncList<string> addedGameMods`This should not be changed after starting the server.
availableLucidDreams`[SaveVar(SaveVarFlags.Default)]
public readonly SyncList<string> availableLucidDreams`
bannedGameItems`[SaveVar(SaveVarFlags.Default)]
public readonly SyncList<string> bannedGameItems`
ClientEvent_OnActiveLucidDreamsChangedpublic SafeAction ClientEvent_OnActiveLucidDreamsChanged
ClientEvent_OnAvailableLucidDreamsChangedpublic SafeAction ClientEvent_OnAvailableLucidDreamsChanged
ClientEvent_OnBannedItemsChangedpublic SafeAction ClientEvent_OnBannedItemsChanged
ClientEvent_OnCustomDataChangedpublic SafeAction&lt;string&gt; ClientEvent_OnCustomDataChanged
ClientEvent_OnDifficultyChangedpublic SafeAction&lt;string, string&gt; ClientEvent_OnDifficultyChanged
ClientEvent_OnLobbyTagsChangedpublic SafeAction ClientEvent_OnLobbyTagsChanged
ClientEvent_OnStateChangedpublic SafeAction ClientEvent_OnStateChanged
ClientEvent_OnUnlockedGameItemsChangedpublic SafeAction ClientEvent_OnUnlockedGameItemsChanged
customData`[SaveVar(SaveVarFlags.Default)]
public readonly SyncDictionary<string, string> customData`
lobbyTags`[SaveVar(SaveVarFlags.Default)]
public readonly SyncList<string> lobbyTags`
localPlayerDejavuCostpublic int localPlayerDejavuCost
unlockedGameItems`[SaveVar(SaveVarFlags.Default)]
public readonly SyncList<string> unlockedGameItems`

Properties ​

NameDeclarationDescription
allowDejavu`[SaveVar(SaveVarFlags.Default)]
public bool allowDejavu { get; set; }`
allowMidJoins`[SaveVar(SaveVarFlags.Default)]
public AllowMidJoinType allowMidJoins { get; set; }`
difficulty`[SaveVar(SaveVarFlags.Default)]
public string difficulty { get; set; }`
enableVotes`[SaveVar(SaveVarFlags.Default)]
public bool enableVotes { get; set; }`
gameSettingsSaveKey`[SaveVar(SaveVarFlags.Default)]
public string gameSettingsSaveKey { get; set; }`
lobbyDescription`[SaveVar(SaveVarFlags.Default)]
public string lobbyDescription { get; set; }`
lobbyName`[SaveVar(SaveVarFlags.Default)]
public string lobbyName { get; set; }`
maxPlayers`[SaveVar(SaveVarFlags.Default)]
public int maxPlayers { get; set; }`
midJoinBanType`[SaveVar(SaveVarFlags.Default)]
public MidJoinBanType midJoinBanType { get; set; }`This is irreversible by design.
midJoinWaitTypepublic MidJoinWaitType midJoinWaitType { get; set; }This should be set and unset accordingly mid-run.
statepublic GameState state { get; set; }

Methods ​

AddLucidDream(string) ​

csharp
public void AddLucidDream(string type)

Parameters:

NameTypeDescription
typestring

Awake() ​

csharp
protected override void Awake()

ClearLucidDreams() ​

csharp
public void ClearLucidDreams()

DisconnectByMidJoinBan() ​

csharp
public void DisconnectByMidJoinBan()

DisconnectByMidJoinWaitBlock() ​

csharp
public void DisconnectByMidJoinWaitBlock()

GetLocalPreferredGameSettings() ​

csharp
public PreferredGameSettings GetLocalPreferredGameSettings()

Returns: PreferredGameSettings

Lobby_UpdateAttribute(string) ​

csharp
public UniTask Lobby_UpdateAttribute(string key)

Parameters:

NameTypeDescription
keystring

Returns: Cysharp.Threading.Tasks.UniTask

Lobby_UpdateCanJoinAndGameStarted(bool?) ​

csharp
public UniTask Lobby_UpdateCanJoinAndGameStarted(bool? hasGameStartedOverride = null)

Parameters:

NameTypeDescription
hasGameStartedOverridebool?

Returns: Cysharp.Threading.Tasks.UniTask

Lobby_UpdateGameAttributes() ​

csharp
public UniTask Lobby_UpdateGameAttributes()

Returns: Cysharp.Threading.Tasks.UniTask

Lobby_UpdateGameStartTimestamp() ​

csharp
public UniTask Lobby_UpdateGameStartTimestamp()

Returns: Cysharp.Threading.Tasks.UniTask

LogicUpdate(float) ​

csharp
public override void LogicUpdate(float dt)

Parameters:

NameTypeDescription
dtfloat

OnStartClient() ​

csharp
public override void OnStartClient()

OnStartServer() ​

csharp
public override void OnStartServer()

OnStopServer() ​

csharp
public override void OnStopServer()

RemoveLucidDream(string) ​

csharp
public void RemoveLucidDream(string type)

Parameters:

NameTypeDescription
typestring

SetEnableVotes(bool) ​

csharp
public void SetEnableVotes(bool value)

Parameters:

NameTypeDescription
valuebool

UpdateAvailableLucidDreams() ​

csharp
public void UpdateAvailableLucidDreams()

ValidateBannedItems(bool) ​

csharp
public void ValidateBannedItems(bool printMessage)

Parameters:

NameTypeDescription
printMessagebool

Maintained by the Shape of Dreams Modding Community