Class CosmosConsoleConfig
Inheritance
CosmosConsoleConfig
Assembly: cs.temp.dll.dll
Syntax
public class CosmosConsoleConfig
Fields
allowGuestLogin
Declaration
public bool allowGuestLogin
Field Value
clientConnectionTimeout
Declaration
public float clientConnectionTimeout
Field Value
commandCategories
Declaration
public List<string> commandCategories
Field Value
commandList
Declaration
public List<CommandDefinition> commandList
Field Value
remoteConsolePort
Declaration
public int remoteConsolePort
Field Value
throttleLoginAttempts
Declaration
public bool throttleLoginAttempts
Field Value
throttleLoginDelay
Declaration
public float throttleLoginDelay
Field Value
throttleMinAttempts
Declaration
public int throttleMinAttempts
Field Value
users
Max 31 users are supported
Declaration
public List<UserDefinition> users
Field Value
Methods
Copy()
Declaration
public CosmosConsoleConfig Copy()
Returns
DeserializeFrom(Byte[], Boolean)
Deserialize config from byte array. Specify if it came from a remote server to adjust for correct format.
Declaration
public void DeserializeFrom(byte[] bytes, bool fromServer = false)
Parameters
DeserializeParameterValues(Byte[])
Declaration
public void DeserializeParameterValues(byte[] bytes)
Parameters
| Type |
Name |
Description |
| Byte[] |
bytes |
|
GetCombinedHintConfig(CosmosConsoleConfig)
Combines commands from the current command list with those of the the provided remoteConfig's command list, for hint purposes.
Any disabled commands from either list are skipped. Only commands with forceRunLocal checked are added from the local list and only the commands
that do NOT have forceRunLocal checked are added from the remoteConfig's list. If a command in the remoteConfig already has an equivalent command
(same keyword) in the local command list, the definition from the local list is used and the remoteConfig's one is ignored.
Declaration
public CosmosConsoleConfig GetCombinedHintConfig(CosmosConsoleConfig remoteConfig)
Parameters
Returns
| Type |
Description |
| CosmosConsoleConfig |
CosmosConsoleConfig with combined command list and command categories list. Other fields are left at default.
|
GetCommandById(Int32)
Declaration
public CommandDefinition GetCommandById(int id)
Parameters
| Type |
Name |
Description |
| Int32 |
id |
|
Returns
GetCommandIdByKeyword(String)
Declaration
public int GetCommandIdByKeyword(string keyword)
Parameters
| Type |
Name |
Description |
| String |
keyword |
|
Returns
GetSerialized(ICommandSender)
Get serialized version of config in byte array. If sender is specified, serializes a stripped-down version that excludes
commands that the sender doesn't have access to, and fields that are not required for remote consoles to know about
Declaration
public byte[] GetSerialized(ICommandSender forSender = null)
Parameters
Returns
HasAccessToCommand(ICommandSender, CommandDefinition)
Declaration
public bool HasAccessToCommand(ICommandSender sender, CommandDefinition cmd)
Parameters
Returns
TryGetCommand(String, out CommandDefinition)
Declaration
public bool TryGetCommand(string cmdKeyword, out CommandDefinition cmdDef)
Parameters
Returns
TryGetCommandParameter(String, String, out CommandDefinition, out CommandParameterDefinition)
Declaration
public bool TryGetCommandParameter(string cmdKeyword, string paramKey, out CommandDefinition cmdDef, out CommandParameterDefinition paramDef)
Parameters
Returns
TryGetSerializedParameterValues(ICommandSender, String, String, out Byte[])
Declaration
public bool TryGetSerializedParameterValues(ICommandSender forSender, string cmdKeyword, string paramKey, out byte[] serializedData)
Parameters
Returns
TryGetUser(String, out UserDefinition)
Declaration
public bool TryGetUser(string username, out UserDefinition userDef)
Parameters
Returns