Class: GamePlay::Options::Helper

Inherits:
Object
  • Object
show all
Defined in:
docs/4_Systems_105_Options.rb

Overview

Option helper allowing to work with a specific option (get next value, set it etc…)

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(*args) ⇒ Helper

Create a new option

Parameters:

  • args (Array) —

    options arguments



272
273
 
# File 'docs/4_Systems_105_Options.rb', line 272

def initialize(*args)
end

Instance Attribute Details

#description ⇒ String

Option description

Returns:



263
264
265
 
# File 'docs/4_Systems_105_Options.rb', line 263

def description
  @description
end

#getter ⇒ Symbol (readonly)

Option getter (on $options)

Returns:

  • (Symbol) 


266
267
268
 
# File 'docs/4_Systems_105_Options.rb', line 266

def getter
  @getter
end

#name ⇒ String

Option name

Returns:



260
261
262
 
# File 'docs/4_Systems_105_Options.rb', line 260

def name
  @name
end

#setter ⇒ Symbol (readonly)

Option setter (on $options)

Returns:

  • (Symbol) 


269
270
271
 
# File 'docs/4_Systems_105_Options.rb', line 269

def setter
  @setter
end

#type ⇒ Symbol (readonly)

Option type

Returns:

  • (Symbol) 


251
252
253
 
# File 'docs/4_Systems_105_Options.rb', line 251

def type
  @type
end

#values ⇒ Array (readonly)

Option values

Returns:

  • (Array) 


254
255
256
 
# File 'docs/4_Systems_105_Options.rb', line 254

def values
  @values
end

#values_text ⇒ Array<String>, String

Option value text(s)

Returns:



257
258
259
 
# File 'docs/4_Systems_105_Options.rb', line 257

def values_text
  @values_text
end

Instance Method Details

#current_value ⇒ Object

Retreive the current value

Returns:



276
277
 
# File 'docs/4_Systems_105_Options.rb', line 276

def current_value
end

#next_value ⇒ Object

Retreive the next value

Returns:



280
281
 
# File 'docs/4_Systems_105_Options.rb', line 280

def next_value
end

#prev_value ⇒ Object

Retreive the prev value

Returns:



284
285
 
# File 'docs/4_Systems_105_Options.rb', line 284

def prev_value
end

#update_value(new_value)

Update the option value

Parameters:



288
289
 
# File 'docs/4_Systems_105_Options.rb', line 288

def update_value(new_value)
end