|
@@ -0,0 +1,324 @@
|
|
|
|
+<?xml version="1.0"?>
|
|
|
|
+<doc>
|
|
|
|
+ <assembly>
|
|
|
|
+ <name>artemis</name>
|
|
|
|
+ </assembly>
|
|
|
|
+ <members>
|
|
|
|
+ <member name="M:Artemis.EntitySystem.Begin">
|
|
|
|
+ Called before processing of entities begins.
|
|
|
|
+ </member>
|
|
|
|
+ <member name="M:Artemis.EntitySystem.End">
|
|
|
|
+ Called after the processing of entities ends.
|
|
|
|
+ </member>
|
|
|
|
+ <member name="M:Artemis.EntitySystem.ProcessEntities(System.Collections.Generic.Dictionary{System.Int32,Artemis.Entity})">
|
|
|
|
+ Any implementing entity system must implement this method and the logic
|
|
|
|
+ to process the given entities of the system.
|
|
|
|
+
|
|
|
|
+ @param entities the entities this system contains.
|
|
|
|
+ </member>
|
|
|
|
+ <member name="M:Artemis.EntitySystem.CheckProcessing">
|
|
|
|
+
|
|
|
|
+ @return true if the system should be processed, false if not.
|
|
|
|
+ </member>
|
|
|
|
+ <member name="M:Artemis.EntitySystem.Initialize">
|
|
|
|
+ Override to implement code that gets executed when systems are initialized.
|
|
|
|
+ </member>
|
|
|
|
+ <member name="M:Artemis.EntitySystem.Added(Artemis.Entity)">
|
|
|
|
+ Called if the system has received a entity it is interested in, e.g. created or a component was added to it.
|
|
|
|
+ @param e the entity that was added to this system.
|
|
|
|
+ </member>
|
|
|
|
+ <member name="M:Artemis.EntitySystem.Removed(Artemis.Entity)">
|
|
|
|
+ Called if a entity was removed from this system, e.g. deleted or had one of it's components removed.
|
|
|
|
+ @param e the entity that was removed from this system.
|
|
|
|
+ </member>
|
|
|
|
+ <member name="M:Artemis.EntitySystem.GetMergedTypes(System.Type,System.Type[])">
|
|
|
|
+ Merge together a required type and a array of other types. Used in derived systems.
|
|
|
|
+ @param requiredType
|
|
|
|
+ @param otherTypes
|
|
|
|
+ @return
|
|
|
|
+ </member>
|
|
|
|
+ <member name="M:Artemis.IntervalEntityProcessingSystem.#ctor(System.Int32,System.Type,System.Type[])">
|
|
|
|
+ Create a new IntervalEntityProcessingSystem. It requires at least one component.
|
|
|
|
+ @param requiredType the required component type.
|
|
|
|
+ @param otherTypes other component types.
|
|
|
|
+ </member>
|
|
|
|
+ <member name="M:Artemis.IntervalEntityProcessingSystem.Process(Artemis.Entity)">
|
|
|
|
+ Process a entity this system is interested in.
|
|
|
|
+ @param e the entity to process.
|
|
|
|
+ </member>
|
|
|
|
+ <member name="M:Artemis.DelayedEntitySystem.ProcessEntities(System.Collections.Generic.Dictionary{System.Int32,Artemis.Entity},System.Int32)">
|
|
|
|
+ The entities to process with accumulated delta.
|
|
|
|
+ @param entities read-only bag of entities.
|
|
|
|
+ </member>
|
|
|
|
+ <member name="M:Artemis.DelayedEntitySystem.StartDelayedRun(System.Int32)">
|
|
|
|
+ Start processing of entities after a certain amount of milliseconds.
|
|
|
|
+
|
|
|
|
+ Cancels current delayed run and starts a new one.
|
|
|
|
+
|
|
|
|
+ @param delay time delay in milliseconds until processing starts.
|
|
|
|
+ </member>
|
|
|
|
+ <member name="M:Artemis.DelayedEntitySystem.GetInitialTimeDelay">
|
|
|
|
+ Get the initial delay that the system was ordered to process entities after.
|
|
|
|
+
|
|
|
|
+ @return the originally set delay.
|
|
|
|
+ </member>
|
|
|
|
+ <member name="M:Artemis.DelayedEntitySystem.IsRunning">
|
|
|
|
+ Check if the system is counting down towards processing.
|
|
|
|
+
|
|
|
|
+ @return true if it's counting down, false if it's not running.
|
|
|
|
+ </member>
|
|
|
|
+ <member name="M:Artemis.DelayedEntitySystem.Stop">
|
|
|
|
+ Aborts running the system in the future and stops it. Call delayedRun() to start it again.
|
|
|
|
+ </member>
|
|
|
|
+ <member name="M:Artemis.TagSystem.Process(Artemis.Entity)">
|
|
|
|
+ Process a entity this system is interested in.
|
|
|
|
+ @param e the entity to process.
|
|
|
|
+ </member>
|
|
|
|
+ <member name="M:Artemis.EntityWorld.GetDelta">
|
|
|
|
+ Time since last game loop.
|
|
|
|
+ @return delta in milliseconds.
|
|
|
|
+ </member>
|
|
|
|
+ <member name="M:Artemis.EntityWorld.SetDelta(System.Int32)">
|
|
|
|
+ You must specify the delta for the game here.
|
|
|
|
+
|
|
|
|
+ @param delta time since last game loop.
|
|
|
|
+ </member>
|
|
|
|
+ <member name="M:Artemis.EntityWorld.DeleteEntity(Artemis.Entity)">
|
|
|
|
+ Delete the provided entity from the world.
|
|
|
|
+ @param e entity
|
|
|
|
+ </member>
|
|
|
|
+ <member name="M:Artemis.EntityWorld.RefreshEntity(Artemis.Entity)">
|
|
|
|
+ Ensure all systems are notified of changes to this entity.
|
|
|
|
+ @param e entity
|
|
|
|
+ </member>
|
|
|
|
+ <member name="M:Artemis.EntityWorld.CreateEntity">
|
|
|
|
+ Create and return a new or reused entity instance.
|
|
|
|
+ @return entity
|
|
|
|
+ </member>
|
|
|
|
+ <member name="M:Artemis.EntityWorld.GetEntity(System.Int32)">
|
|
|
|
+ Get a entity having the specified id.
|
|
|
|
+ @param entityId
|
|
|
|
+ @return entity
|
|
|
|
+ </member>
|
|
|
|
+ <member name="M:Artemis.SystemManager.InitializeAll">
|
|
|
|
+ After adding all systems to the world, you must initialize them all.
|
|
|
|
+ </member>
|
|
|
|
+ <member name="M:Artemis.GroupSystem.Process(Artemis.Entity)">
|
|
|
|
+ Process a entity this system is interested in.
|
|
|
|
+ @param e the entity to process.
|
|
|
|
+ </member>
|
|
|
|
+ <member name="M:Artemis.EntityManager.IsActive(System.Int32)">
|
|
|
|
+ Check if this entity is active, or has been deleted, within the framework.
|
|
|
|
+
|
|
|
|
+ @param entityId
|
|
|
|
+ @return active or not.
|
|
|
|
+ </member>
|
|
|
|
+ <member name="M:Artemis.EntityManager.GetEntityCount">
|
|
|
|
+
|
|
|
|
+ @return how many entities are currently active.
|
|
|
|
+ </member>
|
|
|
|
+ <member name="M:Artemis.EntityManager.GetTotalCreated">
|
|
|
|
+
|
|
|
|
+ @return how many entities have been created since start.
|
|
|
|
+ </member>
|
|
|
|
+ <member name="M:Artemis.EntityManager.GetTotalRemoved">
|
|
|
|
+
|
|
|
|
+ @return how many entities have been removed since start.
|
|
|
|
+ </member>
|
|
|
|
+ <member name="M:Artemis.EntityProcessingSystem.#ctor(System.Type,System.Type[])">
|
|
|
|
+ Create a new EntityProcessingSystem. It requires at least one component.
|
|
|
|
+ @param requiredType the required component type.
|
|
|
|
+ @param otherTypes other component types.
|
|
|
|
+ </member>
|
|
|
|
+ <member name="M:Artemis.EntityProcessingSystem.Process(Artemis.Entity)">
|
|
|
|
+ Process a entity this system is interested in.
|
|
|
|
+ @param e the entity to process.
|
|
|
|
+ </member>
|
|
|
|
+ <member name="M:Artemis.ParallelEntityProcessingSystem.#ctor(System.Type,System.Type[])">
|
|
|
|
+ Create a new EntityProcessingSystem. It requires at least one component.
|
|
|
|
+ @param requiredType the required component type.
|
|
|
|
+ @param otherTypes other component types.
|
|
|
|
+ </member>
|
|
|
|
+ <member name="M:Artemis.ParallelEntityProcessingSystem.Process(Artemis.Entity)">
|
|
|
|
+ Process a entity this system is interested in.
|
|
|
|
+ @param e the entity to process.
|
|
|
|
+ </member>
|
|
|
|
+ <member name="M:Artemis.DelayedEntityProcessingSystem.#ctor(System.Type,System.Type[])">
|
|
|
|
+ Create a new DelayedEntityProcessingSystem. It requires at least one component.
|
|
|
|
+ @param requiredType the required component type.
|
|
|
|
+ @param otherTypes other component types.
|
|
|
|
+ </member>
|
|
|
|
+ <member name="M:Artemis.DelayedEntityProcessingSystem.Process(Artemis.Entity,System.Int32)">
|
|
|
|
+ Process a entity this system is interested in.
|
|
|
|
+ @param e the entity to process.
|
|
|
|
+ </member>
|
|
|
|
+ <member name="M:Artemis.GroupManager.Set(System.String,Artemis.Entity)">
|
|
|
|
+ Set the group of the entity.
|
|
|
|
+
|
|
|
|
+ @param group group to set the entity into.
|
|
|
|
+ @param e entity to set into the group.
|
|
|
|
+ </member>
|
|
|
|
+ <member name="M:Artemis.GroupManager.getEntities(System.String)">
|
|
|
|
+ Get all entities that belong to the provided group.
|
|
|
|
+ @param group name of the group.
|
|
|
|
+ @return read-only bag of entities belonging to the group.
|
|
|
|
+ </member>
|
|
|
|
+ <member name="M:Artemis.GroupManager.Remove(Artemis.Entity)">
|
|
|
|
+ Removes the provided entity from the group it is assigned to, if any.
|
|
|
|
+ @param e the entity.
|
|
|
|
+ </member>
|
|
|
|
+ <member name="M:Artemis.GroupManager.GetGroupOf(Artemis.Entity)">
|
|
|
|
+ @param e entity
|
|
|
|
+ @return the name of the group that this entity belongs to, null if none.
|
|
|
|
+ </member>
|
|
|
|
+ <member name="M:Artemis.GroupManager.IsGrouped(Artemis.Entity)">
|
|
|
|
+ Checks if the entity belongs to any group.
|
|
|
|
+ @param e the entity to check.
|
|
|
|
+ @return true if it is in any group, false if none.
|
|
|
|
+ </member>
|
|
|
|
+ <member name="M:Artemis.Bag`1.#ctor">
|
|
|
|
+ Constructs an empty Bag with an initial capacity of 64.
|
|
|
|
+
|
|
|
|
+ </member>
|
|
|
|
+ <member name="M:Artemis.Bag`1.#ctor(System.Int32)">
|
|
|
|
+ Constructs an empty Bag with the specified initial capacity.
|
|
|
|
+
|
|
|
|
+ @param capacity
|
|
|
|
+ the initial capacity of Bag
|
|
|
|
+ </member>
|
|
|
|
+ <member name="M:Artemis.Bag`1.Remove(System.Int32)">
|
|
|
|
+ Removes the element at the specified position in this Bag. does this by
|
|
|
|
+ overwriting it was last element then removing last element
|
|
|
|
+
|
|
|
|
+ @param index
|
|
|
|
+ the index of element to be removed
|
|
|
|
+ @return element that was removed from the Bag
|
|
|
|
+ </member>
|
|
|
|
+ <member name="M:Artemis.Bag`1.RemoveLast">
|
|
|
|
+ Remove and return the last object in the bag.
|
|
|
|
+
|
|
|
|
+ @return the last object in the bag, null if empty.
|
|
|
|
+ </member>
|
|
|
|
+ <member name="M:Artemis.Bag`1.Remove(`0)">
|
|
|
|
+ Removes the first occurrence of the specified element from this Bag, if
|
|
|
|
+ it is present. If the Bag does not contain the element, it is unchanged.
|
|
|
|
+ does this by overwriting it was last element then removing last element
|
|
|
|
+
|
|
|
|
+ @param o
|
|
|
|
+ element to be removed from this list, if present
|
|
|
|
+ @return <tt>true</tt> if this list contained the specified element
|
|
|
|
+ </member>
|
|
|
|
+ <member name="M:Artemis.Bag`1.Contains(`0)">
|
|
|
|
+ Check if bag contains this element.
|
|
|
|
+
|
|
|
|
+ @param o
|
|
|
|
+ @return
|
|
|
|
+ </member>
|
|
|
|
+ <member name="M:Artemis.Bag`1.RemoveAll(Artemis.Bag{`0})">
|
|
|
|
+ Removes from this Bag all of its elements that are contained in the
|
|
|
|
+ specified Bag.
|
|
|
|
+
|
|
|
|
+ @param bag
|
|
|
|
+ Bag containing elements to be removed from this Bag
|
|
|
|
+ @return {@code true} if this Bag changed as a result of the call
|
|
|
|
+ </member>
|
|
|
|
+ <member name="M:Artemis.Bag`1.Get(System.Int32)">
|
|
|
|
+ Returns the element at the specified position in Bag.
|
|
|
|
+
|
|
|
|
+ @param index
|
|
|
|
+ index of the element to return
|
|
|
|
+ @return the element at the specified position in bag
|
|
|
|
+ </member>
|
|
|
|
+ <member name="M:Artemis.Bag`1.Size">
|
|
|
|
+ Returns the number of elements in this bag.
|
|
|
|
+
|
|
|
|
+ @return the number of elements in this bag
|
|
|
|
+ </member>
|
|
|
|
+ <member name="M:Artemis.Bag`1.GetCapacity">
|
|
|
|
+ Returns the number of elements the bag can hold without growing.
|
|
|
|
+
|
|
|
|
+ @return the number of elements the bag can hold without growing.
|
|
|
|
+ </member>
|
|
|
|
+ <member name="M:Artemis.Bag`1.IsEmpty">
|
|
|
|
+ Returns true if this list contains no elements.
|
|
|
|
+
|
|
|
|
+ @return true if this list contains no elements
|
|
|
|
+ </member>
|
|
|
|
+ <member name="M:Artemis.Bag`1.Add(`0)">
|
|
|
|
+ Adds the specified element to the end of this bag. if needed also
|
|
|
|
+ increases the capacity of the bag.
|
|
|
|
+
|
|
|
|
+ @param o
|
|
|
|
+ element to be added to this list
|
|
|
|
+ </member>
|
|
|
|
+ <member name="M:Artemis.Bag`1.Set(System.Int32,`0)">
|
|
|
|
+ Set element at specified index in the bag.
|
|
|
|
+
|
|
|
|
+ @param index position of element
|
|
|
|
+ @param o the element
|
|
|
|
+ </member>
|
|
|
|
+ <member name="M:Artemis.Bag`1.Clear">
|
|
|
|
+ Removes all of the elements from this bag. The bag will be empty after
|
|
|
|
+ this call returns.
|
|
|
|
+ </member>
|
|
|
|
+ <member name="M:Artemis.Bag`1.AddAll(Artemis.Bag{`0})">
|
|
|
|
+ Add all items into this bag.
|
|
|
|
+ @param added
|
|
|
|
+ </member>
|
|
|
|
+ <member name="M:Artemis.Entity.GetId">
|
|
|
|
+ The internal id for this entity within the framework. No other entity will have the same ID, but
|
|
|
|
+ ID's are however reused so another entity may acquire this ID if the previous entity was deleted.
|
|
|
|
+
|
|
|
|
+ @return id of the entity.
|
|
|
|
+ </member>
|
|
|
|
+ <member name="M:Artemis.Entity.GetUniqueId">
|
|
|
|
+ Get the unique ID of this entity. Because entity instances are reused internally use this to identify between different instances.
|
|
|
|
+ @return the unique id of this entity.
|
|
|
|
+ </member>
|
|
|
|
+ <member name="M:Artemis.Entity.AddComponent(Artemis.Component)">
|
|
|
|
+ Add a component to this entity.
|
|
|
|
+ @param component to add to this entity
|
|
|
|
+ </member>
|
|
|
|
+ <member name="M:Artemis.Entity.RemoveComponent``1(Artemis.Component)">
|
|
|
|
+ Removes the component from this entity.
|
|
|
|
+ @param component to remove from this entity.
|
|
|
|
+ </member>
|
|
|
|
+ <member name="M:Artemis.Entity.RemoveComponent(Artemis.ComponentType)">
|
|
|
|
+ Faster removal of components from a entity.
|
|
|
|
+ @param component to remove from this entity.
|
|
|
|
+ </member>
|
|
|
|
+ <member name="M:Artemis.Entity.IsActive">
|
|
|
|
+ Checks if the entity has been deleted from somewhere.
|
|
|
|
+ @return if it's active.
|
|
|
|
+ </member>
|
|
|
|
+ <member name="M:Artemis.Entity.GetComponent(Artemis.ComponentType)">
|
|
|
|
+ This is the preferred method to use when retrieving a component from a entity. It will provide good performance.
|
|
|
|
+
|
|
|
|
+ @param type in order to retrieve the component fast you must provide a ComponentType instance for the expected component.
|
|
|
|
+ @return
|
|
|
|
+ </member>
|
|
|
|
+ <!-- Badly formed XML comment ignored for member "M:Artemis.Entity.GetComponent``1" -->
|
|
|
|
+ <member name="M:Artemis.Entity.GetComponents">
|
|
|
|
+ Get all components belonging to this entity.
|
|
|
|
+ WARNING. Use only for debugging purposes, it is dead slow.
|
|
|
|
+ WARNING. The returned bag is only valid until this method is called again, then it is overwritten.
|
|
|
|
+ @return all components of this entity.
|
|
|
|
+ </member>
|
|
|
|
+ <member name="M:Artemis.Entity.Refresh">
|
|
|
|
+ Refresh all changes to components for this entity. After adding or removing components, you must call
|
|
|
|
+ this method. It will update all relevant systems.
|
|
|
|
+ It is typical to call this after adding components to a newly created entity.
|
|
|
|
+ </member>
|
|
|
|
+ <member name="M:Artemis.Entity.Delete">
|
|
|
|
+ Delete this entity from the world.
|
|
|
|
+ </member>
|
|
|
|
+ <member name="M:Artemis.Entity.SetGroup(System.String)">
|
|
|
|
+ Set the group of the entity. Same as World.setGroup().
|
|
|
|
+ @param group of the entity.
|
|
|
|
+ </member>
|
|
|
|
+ <member name="M:Artemis.Entity.SetTag(System.String)">
|
|
|
|
+ Assign a tag to this entity. Same as World.setTag().
|
|
|
|
+ @param tag of the entity.
|
|
|
|
+ </member>
|
|
|
|
+ </members>
|
|
|
|
+</doc>
|