Skip to content
Kward Search API index

Class: Kward::PluginRegistry::InteractiveCommand

Inherits:
Struct
  • Object
show all
Defined in:
lib/kward/plugins/registry.rb

Overview

Registered interactive command that takes over the composer region with a Kward-driven render and input loop. Like a slash command but with canvas rendering capabilities for games, dashboards, viewers, and similar uses.

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#argument_hint ⇒ Object

Returns the value of attribute argument_hint

Returns:

  • (Object) —

    the current value of argument_hint



54
55
56
# File 'lib/kward/plugins/registry.rb', line 54

def argument_hint
  @argument_hint
end

#description ⇒ Object

Returns the value of attribute description

Returns:

  • (Object) —

    the current value of description



54
55
56
# File 'lib/kward/plugins/registry.rb', line 54

def description
  @description
end

#fps ⇒ Object

Returns the value of attribute fps

Returns:

  • (Object) —

    the current value of fps



54
55
56
# File 'lib/kward/plugins/registry.rb', line 54

def fps
  @fps
end

#handler ⇒ Object

Returns the value of attribute handler

Returns:

  • (Object) —

    the current value of handler



54
55
56
# File 'lib/kward/plugins/registry.rb', line 54

def handler
  @handler
end

#name ⇒ Object

Returns the value of attribute name

Returns:

  • (Object) —

    the current value of name



54
55
56
# File 'lib/kward/plugins/registry.rb', line 54

def name
  @name
end

#path ⇒ Object

Returns the value of attribute path

Returns:

  • (Object) —

    the current value of path



54
55
56
# File 'lib/kward/plugins/registry.rb', line 54

def path
  @path
end

#rows ⇒ Object

Returns the value of attribute rows

Returns:

  • (Object) —

    the current value of rows



54
55
56
# File 'lib/kward/plugins/registry.rb', line 54

def rows
  @rows
end

Instance Method Details

#entry ⇒ Object



55
56
57
# File 'lib/kward/plugins/registry.rb', line 55

def entry
  { name: name, description: description, argument_hint: argument_hint }
end