Class: FelFlame::ComponentManager

Inherits:
Object
  • Object
show all
Defined in:
component_manager.rb

Overview

Component Managers are what is used to create individual components which can be attached to entities. When a Component is created from a Component Manager that has accessors given to it, you can set or get the values of those accessors using standard ruby message sending (e.g @component.var = 5), or by using the #attrs and #update_attrs methods instead.

Class Attribute Summary collapse

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**attrs) ⇒ Component

Creates a new component and sets the values of the attributes given to it. If an attritbute is not passed then it will remain as the default.

Parameters:

  • attrs (Keyword: Value) —

    You can pass any number of Keyword-Value pairs



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'component_manager.rb', line 100

def initialize(**attrs)
  # Prepare the object
  # (this is a function created with metaprogramming
  # in FelFlame::Components
  set_defaults

  # Generate ID
  new_id = self.class.data.find_index { |i| i.nil? }
  new_id = self.class.data.size if new_id.nil?
  @id = new_id

  # Fill params
  attrs.each do |key, value|
    send "#{key}=", value
  end

  # Save Component
  self.class.data[new_id] = self
end

Class Attribute Details

.addition_triggers ⇒ Array<System>

Stores references to systems that should be triggered when this component is added to an enitity. Do not edit this array as it is managed by FelFlame automatically.

Returns:

  • (Array<System>) 


132
133
134
 
# File 'component_manager.rb', line 132

def addition_triggers
  @addition_triggers ||= []
end

.attr_triggers ⇒ Hash<Symbol, System>

Stores references to systems that should be triggered when an attribute from this component changed. Do not edit this hash as it is managed by FelFlame automatically.

Returns:

  • (Hash<Symbol, System>) 


148
149
150
 
# File 'component_manager.rb', line 148

def attr_triggers
  @attr_triggers ||= {}
end

.removal_triggers ⇒ Array<System>

Stores references to systems that should be triggered when this component is removed from an enitity. Do not edit this array as it is managed by FelFlame automatically.

Returns:

  • (Array<System>) 


140
141
142
 
# File 'component_manager.rb', line 140

def removal_triggers
  @removal_triggers ||= []
end

Instance Attribute Details

#addition_triggers ⇒ Array<System>

Stores references to systems that should be triggered when a component from this manager is added. Do not edit this array as it is managed by FelFlame automatically.

Returns:

  • (Array<System>) 


77
78
79
 
# File 'component_manager.rb', line 77

def addition_triggers
  @addition_triggers ||= []
end

#attr_triggers ⇒ Hash<Symbol, Array<System>>

Stores references to systems that should be triggered when an attribute from this manager is changed. Do not edit this hash as it is managed by FelFlame automatically.

Returns:

  • (Hash<Symbol, Array<System>>) 


93
94
95
 
# File 'component_manager.rb', line 93

def attr_triggers
  @attr_triggers ||= {}
end

#id ⇒ Integer

Holds the unique ID of a component. The ID is only unique within the scope of the component manager it was created from.

Returns:

  • (Integer) 


59
60
61
 
# File 'component_manager.rb', line 59

def id
  @id
end

#removal_triggers ⇒ Array<System>

Stores references to systems that should be triggered when a component from this manager is removed. Do not edit this array as it is managed by FelFlame automatically.

Returns:

  • (Array<System>) 


85
86
87
 
# File 'component_manager.rb', line 85

def removal_triggers
  @removal_triggers ||= []
end

Class Method Details

.[](component_id) ⇒ Component

Gets a Component from the given unique ID. Usage is simular to how an Array lookup works.

Examples:

# this gets the 'Health' Component with ID 7
FelFlame::Components::Health[7]

Parameters:

  • component_id (Integer)

Returns:

  • (Component) —

    Returns the Component that uses the given unique ID, nil if there is no Component associated with the given ID



165
166
167
 
# File 'component_manager.rb', line 165

def [](component_id)
  data[component_id]
end

.each(&block) ⇒ Enumerator

Iterates over all components within the component manager. Special Enumerable methods like map or each_with_index are not implemented

Returns:

  • (Enumerator) 


172
173
174
 
# File 'component_manager.rb', line 172

def each(&block)
  data.compact.each(&block)
end

Instance Method Details

#attr_changed_trigger_systems(attr) ⇒ Boolean

Execute systems that have been added to execute on variable change

Returns:

  • (Boolean) —

    true



199
200
201
202
203
204
205
206
207
 
# File 'component_manager.rb', line 199

def attr_changed_trigger_systems(attr)
  systems_to_execute = self.class.attr_triggers[attr]
  systems_to_execute = [] if systems_to_execute.nil?

  systems_to_execute |= attr_triggers[attr] unless attr_triggers[attr].nil?

  systems_to_execute.sort_by(&:priority).reverse.each(&:call)
  true
end

#attrs ⇒ Hash<Symbol, Value>

Returns A hash, where all the keys are attributes linked to their respective values.

Returns:

  • (Hash<Symbol, Value>) —

    A hash, where all the keys are attributes linked to their respective values.



230
231
232
233
234
235
236
 
# File 'component_manager.rb', line 230

def attrs
  return_hash = instance_variables.each_with_object({}) do |key, final|
    final[key.to_s.delete_prefix('@').to_sym] = instance_variable_get(key)
  end
  return_hash.delete(:attr_triggers)
  return_hash
end

#delete ⇒ Boolean

Removes this component from the list and purges all references to this Component from other Entities, as well as its ID and data.

Returns:

  • (Boolean) —

    true.



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'component_manager.rb', line 211

def delete
  addition_triggers.each do |system|
    system.clear_triggers component_or_manager: self
  end
  # This needs to be cloned because indices get deleted as
  # the remove command is called, breaking the loop if it
  # wasn't referencing a clone(will get Nil errors)
  iter = entities.map(&:clone)
  iter.each do |entity_id|
    FelFlame::Entities[entity_id].remove self #unless FelFlame::Entities[entity_id].nil?
  end
  self.class.data[id] = nil
  instance_variables.each do |var|
    instance_variable_set(var, nil)
  end
  true
end

#entities ⇒ Array<Integer>

A list of entity ids that are linked to the component

Returns:

  • (Array<Integer>) 


185
186
187
 
# File 'component_manager.rb', line 185

def entities
  @entities ||= []
end

#to_i ⇒ Integer

An alias for the ID Reader

Returns:

  • (Integer) 


179
180
181
 
# File 'component_manager.rb', line 179

def to_i
  id
end

#update_attrs(**opts) ⇒ Hash<Symbol, Value>

Update attribute values using a hash or keywords.

Returns:

  • (Hash<Symbol, Value>) —

    Hash of updated attributes



191
192
193
194
195
 
# File 'component_manager.rb', line 191

def update_attrs(**opts)
  opts.each do |key, value|
    send "#{key}=", value
  end
end