InterfaceCommand

InterfaceCommand

Kind: global class

• InterfaceCommand
  • new InterfaceCommand(command, [name], [style], [tooltip], [actionSound], [hoverSound], [tags])
  • instance
    • .name : string
    • .command : InteractionCommand
    • .style : Object
    • .actionSound : SoundTrack
    • .hoverSound : SoundTrack
    • .tooltip : string
    • .tags : Array.<string>
    • .id ⇒ string
    • .enabled ⇒ ObservedBoolean | ReactiveExpression
    • .features ⇒ List.<String>
    • .action ⇒ function
    • .hasTag(tag) ⇒ boolean
  • static
    • .form(command, [style], [actionSound], [hoverSound], [tooltip], [tags]) ⇒ InterfaceCommand

new InterfaceCommand(command, [name], [style], [tooltip], [actionSound], [hoverSound], [tags])

Param	Type
command	InteractionCommand
[name]	string
[style]	Object
[tooltip]	string
[actionSound]	SoundTrack
[hoverSound]	SoundTrack
[tags]	Array.<string>

interfaceCommand.name : string

Name for the command, this is a localization key

Kind: instance property of InterfaceCommand

interfaceCommand.command : InteractionCommand

Kind: instance property of InterfaceCommand

interfaceCommand.style : Object

Kind: instance property of InterfaceCommand

interfaceCommand.actionSound : SoundTrack

Kind: instance property of InterfaceCommand

interfaceCommand.hoverSound : SoundTrack

Kind: instance property of InterfaceCommand

interfaceCommand.tooltip : string

Localization key for the tooltip

Kind: instance property of InterfaceCommand

interfaceCommand.tags : Array.<string>

Kind: instance property of InterfaceCommand

interfaceCommand.id ⇒ string

Deprecated

Kind: instance property of InterfaceCommand

interfaceCommand.enabled ⇒ ObservedBoolean | ReactiveExpression

Deprecated

Kind: instance property of InterfaceCommand

interfaceCommand.features ⇒ List.<String>

Deprecated

Kind: instance property of InterfaceCommand

interfaceCommand.action ⇒ function

Deprecated

Kind: instance property of InterfaceCommand

interfaceCommand.hasTag(tag) ⇒ boolean

Kind: instance method of InterfaceCommand

Param	Type
tag	string

InterfaceCommand.form(command, [style], [actionSound], [hoverSound], [tooltip], [tags]) ⇒ InterfaceCommand

Kind: static method of InterfaceCommand

Param	Type
command	InteractionCommand
[style]	Object
[actionSound]	SoundTrack
[hoverSound]	SoundTrack
[tooltip]	string
[tags]	Array.<string>