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

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

Overview

Displays module for commandcenter/scenetypes endpoints

Instance Method Summary collapse

Instance Method Details

#get_scene_type(scene_type_id) ⇒ Hashie::Mash

Get an existing scene type

Parameters:

  • scene_type_id (Integer) —

    the scene type id

Returns:

  • (Hashie::Mash) —

    Specific scene type



19
20
21
 
# File 'lib/bwapi/client/command_center/scene_types.rb', line 19

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

#get_scene_type_with_sub_scenes(scene_type_id) ⇒ Hashie::Mash

Get an existing scene type

Parameters:

  • scene_type_id (Integer) —

    the scene type id

Returns:

  • (Hashie::Mash) —

    Specific scene type with sub scences



27
28
29
 
# File 'lib/bwapi/client/command_center/scene_types.rb', line 27

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

#scene_types ⇒ Hashie::Mash

Get the scene types visible to the user

Returns:

  • (Hashie::Mash) —

    All scene types



11
12
13
 
# File 'lib/bwapi/client/command_center/scene_types.rb', line 11

def scene_types
  get 'commandcenter/scenetypes'
end