CmdrClient
client only
↪ Extends Cmdr
Properties
# Registry
CmdrClient.Registry: RegistryRefers to the current command Registry.
# Dispatcher
CmdrClient.Dispatcher: DispatcherRefers to the current command Dispatcher.
# Util
CmdrClient.Util: UtilRefers to a table containing many useful utility functions.
# Enabled
CmdrClient.Enabled: boolean# PlaceName
CmdrClient.PlaceName: string# ActivationKeys
CmdrClient.ActivationKeys: dictionary<Enum.KeyCode, true>Instance Methods
# SetActivationKeys
CmdrClient.SetActivationKeys(keys: array<Enum.KeyCode>) →
Sets the key codes that will hide or show Cmdr.
Parameters
| Name | Type | Required | |
|---|---|---|---|
keys | array<Enum.KeyCode> | ✔ |
Returns
| Type |
|---|
# SetPlaceName
CmdrClient.SetPlaceName(labelText: string) →
Sets the place name label that appears when executing commands. This is useful for a quick way to tell what game you're playing in a universe game.
Parameters
| Name | Type | Required | |
|---|---|---|---|
labelText | string | ✔ |
Returns
| Type |
|---|
# SetEnabled
CmdrClient.SetEnabled(isEnabled: boolean) →
Sets whether or not Cmdr can be shown via the defined activation keys. Useful for when you want users to need to opt-in to show the console in a settings menu.
Parameters
| Name | Type | Required | |
|---|---|---|---|
isEnabled | boolean | ✔ |
Returns
| Type |
|---|
# Show
CmdrClient.Show() →
Shows the Cmdr window explicitly. Does not do anything if Cmdr is not enabled.
Returns
| Type |
|---|
# Toggle
CmdrClient.Toggle() →
Toggles visibility of the Cmdr window. Will not show if Cmdr is not enabled.
Returns
| Type |
|---|
# HandleEvent
CmdrClient.HandleEvent(string,
handler: function(...?: any?) →
Parameters
| Name | Type | Required | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
event | string | ✔ | |||||||||||
handler | DetailsParameters
Returns
| ✔ |
Returns
| Type |
|---|
# SetMashToEnable
CmdrClient.SetMashToEnable(isEnabled: boolean) →
Parameters
| Name | Type | Required | |
|---|---|---|---|
isEnabled | boolean | ✔ |
Returns
| Type |
|---|
# SetActivationUnlocksMouse
CmdrClient.SetActivationUnlocksMouse(isEnabled: boolean) →
Parameters
| Name | Type | Required | |
|---|---|---|---|
isEnabled | boolean | ✔ |
Returns
| Type |
|---|
# SetHideOnLostFocus
CmdrClient.SetHideOnLostFocus(isEnabled: boolean) →
Parameters
| Name | Type | Required | |
|---|---|---|---|
isEnabled | boolean | ✔ |
Returns
| Type |
|---|
← Cmdr CommandContext →