From a6004b2fccca58e528d24be5ba8afdf781666662 Mon Sep 17 00:00:00 2001 From: realtradam Date: Thu, 3 Feb 2022 04:12:35 -0500 Subject: added new group method for entity manager --- docs/FelFlame/Components.html | 333 ------------------------------------------ 1 file changed, 333 deletions(-) delete mode 100644 docs/FelFlame/Components.html (limited to 'docs/FelFlame/Components.html') diff --git a/docs/FelFlame/Components.html b/docs/FelFlame/Components.html deleted file mode 100644 index be924da..0000000 --- a/docs/FelFlame/Components.html +++ /dev/null @@ -1,333 +0,0 @@ - - - - - - - Module: FelFlame::Components - - — Documentation by YARD 0.9.26 - - - - - - - - - - - - - - - - - -
- -
-
- -
- - -

Module: FelFlame::Components - - - -

-
- - - - - - - - - - - -
-
Defined in:
-
lib/felflame.rb,
- lib/felflame/component_manager.rb -
-
- -
- -

Overview

-
- -

Creates component managers and allows accessing them them under the Components namespace as Constants. You can use array methods directly on this class to access Component Managers.

- -

To see how component managers are used please look at the ComponentManager documentation.

- - -
-
-
- - -
- - - - - - - -

- Class Method Summary - collapse -

- - - - - - -
-

Class Method Details

- - -
-

- - .new(component_name, *attrs, **attrs_with_defaults) ⇒ ComponentManager - - - - - -

-
- -

Creates a new component manager.

- - -
-
-
- -
-

Examples:

- - - 
# Here color is set to default to red
-# while max and current are nil until set.
-# When you make a new component using this component manager
-# these are the values and accessors it will have.
-FelFlame::Component.new('Health', :max, :current, color: 'red')
- -
-

Parameters:

-
    - -
  • - - component_name - - - (String) - - - - — -
    -

    Name of your new component manager. Must be stylized in the format of constants in Ruby

    -
    - -
    • - -
  • - - attrs - - - (:Symbols) - - - - — -
    -

    New components made with this manager will include these symbols as accessors, the values of these accessors will default to nil

    -
    - -
    • - -
  • - - attrs_with_defaults - - - (Keyword: DefaultValue) - - - - — -
    -

    New components made with this manager will include these keywords as accessors, their defaults set to the values given to the keywords

    -
    - -
    • - -
- -

Returns:

- - -
- - - - -
- 
-
-
-20
-21
-22
-23
-24
-25
-26
-27
-28
-29
-30
-31
-32
-33
-34
-35
-36
-37
-38
-39
-40
-41
-42
-43
-44
-45
-46
-47
-48
-49
- 		- 
# File 'lib/felflame/component_manager.rb', line 20
-
-def new(component_name, *attrs, **attrs_with_defaults)
-  if FelFlame::Components.const_defined?(component_name)
-    raise(NameError.new, "Component Manager '#{component_name}' is already defined")
-  end
-
-  const_set(component_name, Class.new(FelFlame::ComponentManager) {})
-  update_const_cache
-
-  attrs.each do |attr|
-    if FelFlame::Components.const_get(component_name).method_defined?(attr.to_s) || FelFlame::Components.const_get(component_name).method_defined?("#{attr}=")
-      raise NameError, "The attribute name \"#{attr}\" is already a method"
-    end
-
-    FelFlame::Components.const_get(component_name).attr_accessor attr
-  end
-  attrs_with_defaults.each do |attr, _default|
-    attrs_with_defaults[attr] = _default.dup
-    FelFlame::Components.const_get(component_name).attr_reader attr
-    FelFlame::Components.const_get(component_name).define_method("#{attr}=") do |value|
-      attr_changed_trigger_systems(attr) unless value.equal? send(attr)
-      instance_variable_set("@#{attr}", value)
-    end
-  end
-  FelFlame::Components.const_get(component_name).define_method(:set_defaults) do
-    attrs_with_defaults.each do |attr, default|
-      instance_variable_set("@#{attr}", default.dup)
-    end
-  end
-  FelFlame::Components.const_get(component_name)
-end
-
-
- -
- -
- - - -
- - \ No newline at end of file -- cgit v1.2.3