From 4758c32fbd5cba714341f9735a994fd244664ff7 Mon Sep 17 00:00:00 2001 From: realtradam Date: Wed, 7 Jul 2021 01:06:51 -0400 Subject: cleaned up documentation a little --- docs/FelFlame/Helper/ComponentManager.html | 442 ++++++++++++++++++++--------- 1 file changed, 306 insertions(+), 136 deletions(-) (limited to 'docs/FelFlame/Helper/ComponentManager.html') diff --git a/docs/FelFlame/Helper/ComponentManager.html b/docs/FelFlame/Helper/ComponentManager.html index cce8c36..0d4d93a 100644 --- a/docs/FelFlame/Helper/ComponentManager.html +++ b/docs/FelFlame/Helper/ComponentManager.html @@ -120,7 +120,7 @@
  • - .addition_triggers ⇒ Object + .addition_triggers ⇒ Array<System> @@ -129,6 +129,8 @@ + readonly + @@ -137,7 +139,9 @@ -
    +
    +

    Stores references to systems that should be triggered when this component is added to an enitity.

    +
    • @@ -145,7 +149,7 @@
  • - .attr_triggers ⇒ Object + .attr_triggers ⇒ Hash<Symbol, System> @@ -154,6 +158,8 @@ + readonly + @@ -162,7 +168,9 @@ -
    +
    +

    Stores references to systems that should be triggered when an attribute from this component changed.

    +
    • @@ -170,7 +178,7 @@
  • - .removal_triggers ⇒ Object + .removal_triggers ⇒ Array<System> @@ -179,6 +187,8 @@ + readonly + @@ -187,7 +197,9 @@ -
    +
    +

    Stores references to systems that should be triggered when this component is removed from an enitity.

    +
    • @@ -200,7 +212,7 @@
  • - #addition_triggers ⇒ Object + #addition_triggers ⇒ Array<System> @@ -209,6 +221,8 @@ + readonly + @@ -217,7 +231,9 @@ -
    +
    +

    Stores references to systems that should be triggered when a component from this manager is added.

    +
    • @@ -225,7 +241,7 @@
  • - #attr_triggers ⇒ Object + #attr_triggers ⇒ Hash<Symbol, Array<System>> @@ -234,6 +250,8 @@ + readonly + @@ -242,7 +260,9 @@ -
    +
    +

    Stores references to systems that should be triggered when an attribute from this manager is changed.

    +
    • @@ -259,6 +279,8 @@ + readonly + @@ -277,7 +299,7 @@
  • - #removal_triggers ⇒ Object + #removal_triggers ⇒ Array<System> @@ -286,6 +308,8 @@ + readonly + @@ -294,7 +318,9 @@ -
    +
    +

    Stores references to systems that should be triggered when a component from this manager is removed.

    +
    • @@ -615,28 +641,28 @@ 
     
 
-81
-82
-83
-84
-85
-86
-87
-88
-89
-90
-91
-92
-93
-94
-95
-96
-97
-98
-99
    +104 +105 +106 +107 +108 +109 +110 +111 +112 +113 +114 +115 +116 +117 +118 +119 +120 +121 +122 - 
    # File 'component_manager.rb', line 81
+      
    # File 'component_manager.rb', line 104
 
 def initialize(**attrs)
   # Prepare the object
@@ -672,24 +698,48 @@
       
    
   
    
   
-    .addition_triggers  ⇒ Object 
+    .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>)
+      
+      
+      
+    
      • 
+  
+
    
+
+
    
   
    
     
       
     
 
-104
-105
-106
    
+136
+137
+138
         		
     
-      
    # File 'component_manager.rb', line 104
+      
    # File 'component_manager.rb', line 136
 
 def addition_triggers
   @addition_triggers ||= []
@@ -704,24 +754,48 @@
       
    
   
    
   
-    .attr_triggers  ⇒ Object 
+    .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>)
+      
+      
+      
+    
      • 
+  
+
    
+
+
    
   
    
     
       
     
 
-112
-113
-114
    
+152
+153
+154
         		
     
-      
    # File 'component_manager.rb', line 112
+      
    # File 'component_manager.rb', line 152
 
 def attr_triggers
   @attr_triggers ||= {}
@@ -736,24 +810,48 @@
       
    
   
    
   
-    .removal_triggers  ⇒ Object 
+    .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>)
+      
+      
+      
+    
      • 
+  
+
+
+
      
   
      
     
       
       
 
-108
-109
-110
      
+144
+145
+146
           		
     
-      
      # File 'component_manager.rb', line 108
+      
      # File 'component_manager.rb', line 144
 
 def removal_triggers
   @removal_triggers ||= []
@@ -773,24 +871,48 @@
       
      
   
      
   
-    #addition_triggers  ⇒ Object 
+    #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>)
+      
+      
+      
+    
        • 
+  
+
      
+
+
      
   
      
     
       
       
 
-66
-67
-68
      
+81
+82
+83
           		
     
-      
      # File 'component_manager.rb', line 66
+      
      # File 'component_manager.rb', line 81
 
 def addition_triggers
   @addition_triggers ||= []
@@ -805,24 +927,48 @@
       
      
   
      
   
-    #attr_triggers  ⇒ Object 
+    #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>>)
+      
+      
+      
+    
        • 
+  
+
      
+
+
      
   
      
     
       
       
 
-74
-75
-76
      
+97
+98
+99
           		
     
-      
      # File 'component_manager.rb', line 74
+      
      # File 'component_manager.rb', line 97
 
 def attr_triggers
   @attr_triggers ||= {}
@@ -873,12 +1019,12 @@
       
       
 
-62
 63
-64
      
+64
+65
      
     
      		
     
-      
      # File 'component_manager.rb', line 62
+      
      # File 'component_manager.rb', line 63
 
 def id
   @id
@@ -893,24 +1039,48 @@
       
      
   
      
   
-    #removal_triggers  ⇒ Object 
+    #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>)
+      
+      
+      
+    
        • 
   
-
+
+
+
        
   
        
     
       
         
 
-70
-71
-72
        
+89
+90
+91
             		
     
-      
        # File 'component_manager.rb', line 70
+      
        # File 'component_manager.rb', line 89
 
 def removal_triggers
   @removal_triggers ||= []
@@ -995,12 +1165,12 @@
       
         
 
-129
-130
-131
        
+169
+170
+171
        
     
        		
     
-      
        # File 'component_manager.rb', line 129
+      
        # File 'component_manager.rb', line 169
 
 def [](component_id)
   data[component_id]
@@ -1049,12 +1219,12 @@
       
         
 
-136
-137
-138
        
+176
+177
+178
        
     
        		
     
-      
        # File 'component_manager.rb', line 136
+      
        # File 'component_manager.rb', line 176
 
 def each(&block)
   data.compact.each(&block)
@@ -1096,20 +1266,20 @@
       
         
 
-162
-163
-164
-165
-166
-167
-168
-169
-170
-171
-172
        
+202
+203
+204
+205
+206
+207
+208
+209
+210
+211
+212
        
     
        		
     
-      
        # File 'component_manager.rb', line 162
+      
        # File 'component_manager.rb', line 202
 
 def attr_changed_trigger_systems(attr)
   systems_to_execute = self.class.attr_triggers[attr]
@@ -1171,16 +1341,16 @@
       
         
 
-195
-196
-197
-198
-199
-200
-201
        
+235
+236
+237
+238
+239
+240
+241
        
     
        		
     
-      
        # File 'component_manager.rb', line 195
+      
        # File 'component_manager.rb', line 235
 
 def attrs
   return_hash = instance_variables.each_with_object({}) do |key, final|
@@ -1238,26 +1408,26 @@
       
         
 
-176
-177
-178
-179
-180
-181
-182
-183
-184
-185
-186
-187
-188
-189
-190
-191
-192
        
+216
+217
+218
+219
+220
+221
+222
+223
+224
+225
+226
+227
+228
+229
+230
+231
+232
        
     
        		
     
-      
        # File 'component_manager.rb', line 176
+      
        # File 'component_manager.rb', line 216
 
 def delete
   addition_triggers.each do |system|
@@ -1320,12 +1490,12 @@
       
         
 
-149
-150
-151
        
+189
+190
+191
        
     
        		
     
-      
        # File 'component_manager.rb', line 149
+      
        # File 'component_manager.rb', line 189
 
 def entities
   @entities ||= []
@@ -1374,12 +1544,12 @@
       
         
 
-143
-144
-145
        
+183
+184
+185
        
     
        		
     
-      
        # File 'component_manager.rb', line 143
+      
        # File 'component_manager.rb', line 183
 
 def to_i
   id
@@ -1433,12 +1603,12 @@
       
         
 
-206
-207
-208
        
+246
+247
+248
        
     
        		
     
-      
        # File 'component_manager.rb', line 206
+      
        # File 'component_manager.rb', line 246
 
 def to_json
   # should return a json or hash of all data in this component
@@ -1492,14 +1662,14 @@
       
         
 
-155
-156
-157
-158
-159
        
+195
+196
+197
+198
+199
        
     
        		
     
-      
        # File 'component_manager.rb', line 155
+      
        # File 'component_manager.rb', line 195
 
 def update_attrs(**opts)
   opts.each do |key, value|
@@ -1516,7 +1686,7 @@
 
 
       
-- 
cgit v1.2.3