Module: BWAPI::Client::CommandCenter::SceneTypes

Included in:
BWAPI::Client::CommandCenter
Defined in:
lib/bwapi/client/command_center/scene_types.rb

Overview

SceneTypes module for commandcenter/scenetypes endpoints

Instance Method Summary collapse

Instance Method Details

#get_scene_type(scene_type_id) ⇒ Hash

Get an existing scene type

Parameters:

  • scene_type_id (Integer) —

    the scene type id

Returns:

  • (Hash) —

    Specific scene type



17
18
19
 
# File 'lib/bwapi/client/command_center/scene_types.rb', line 17

def get_scene_type(scene_type_id)
  get "commandcenter/scenetypes/#{scene_type_id}"
end

#get_scene_type_with_sub_scenes(scene_type_id) ⇒ Hash

Get an existing scene type sub scene types

Parameters:

  • scene_type_id (Integer) —

    the scene type id

Returns:

  • (Hash) —

    Specific scene type with sub scences



25
26
27
 
# File 'lib/bwapi/client/command_center/scene_types.rb', line 25

def get_scene_type_with_sub_scenes(scene_type_id)
  get "commandcenter/scenetypes/#{scene_type_id}/subscenes"
end

#scene_types ⇒ Hash

Get the scene types visible to the user

Returns:

  • (Hash) —

    All scene types



9
10
11
 
# File 'lib/bwapi/client/command_center/scene_types.rb', line 9

def scene_types
  get 'commandcenter/scenetypes'
end