Skip to content

Commit

Permalink
updated documentation (closes #139)
Browse files Browse the repository at this point in the history
  • Loading branch information
Doraku committed Feb 11, 2022
1 parent 91ed85a commit 2d8f8bf
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 3 deletions.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -668,8 +668,11 @@ Note that a fixed capacity EntityCommandRecorder (or one which has expanded to i
When needed, an expandable EntityCommandRecorder will double its capacity so it is preferred to use a power of 2 as default capacity.

```csharp
// Get a WorldRecord to record entity creation
WorldRecord worldRecord = recorder.Record(world);

// Create a new Entity defered and give an EntityRecord to record commands on it
EntityRecord newRecord = recorder.Record(world).CreateEntity();
EntityRecord newRecord = worldRecord.CreateEntity();

// Register an Entity and give an EntityRecord to record commands on it
EntityRecord record = recorder.Record(entity);
Expand Down
2 changes: 2 additions & 0 deletions source/DefaultEcs/System/AEntityMultiMapSystem.cs
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ namespace DefaultEcs.System
{
/// <summary>
/// Represents a base class to process updates on a given <see cref="EntityMultiMap{TKey}"/> instance.
/// Only <see cref="Entity.Get{T}()"/> operations on already present component type are safe.
/// Any other operation maybe change the inner <see cref="EntityMultiMap{TKey}"/> and should be done either by setting "useBuffer" of the available constructors to true or using an <see cref="Command.EntityCommandRecorder"/>.
/// </summary>
/// <typeparam name="TState">The type of the object used as state to update the system.</typeparam>
/// <typeparam name="TKey">The type of the component used as key.</typeparam>
Expand Down
3 changes: 2 additions & 1 deletion source/DefaultEcs/System/AEntitySetSystem.cs
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@ namespace DefaultEcs.System
{
/// <summary>
/// Represents a base class to process updates on a given <see cref="EntitySet"/> instance.
/// Only <see cref="Entity.Get{T}()"/>, <see cref="Entity.Set{T}(in T)"/> and <see cref="Entity.SetSameAs{T}(in Entity)"/> operation on already present component type are safe.
/// Only <see cref="Entity.Get{T}()"/> operations on already present component type are safe.
/// Any other operation maybe change the inner <see cref="EntitySet"/> and should be done either by using setting "useBuffer" of the available constructors to true or using an <see cref="Command.EntityCommandRecorder"/>.
/// </summary>
/// <typeparam name="T">The type of the object used as state to update the system.</typeparam>
public abstract class AEntitySetSystem<T> : ISystem<T>
Expand Down
3 changes: 2 additions & 1 deletion source/DefaultEcs/System/AEntitySortedSetSystem.cs
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@ namespace DefaultEcs.System
{
/// <summary>
/// Represents a base class to process updates on a given <see cref="EntitySortedSet{TComponent}"/> instance.
/// Only <see cref="Entity.Get{T}()"/>, <see cref="Entity.Set{T}(in T)"/> and <see cref="Entity.SetSameAs{T}(in Entity)"/> operation on already present component type are safe.
/// Only <see cref="Entity.Get{T}()"/> operations on already present component type are safe.
/// Any other operation maybe change the inner <see cref="EntitySortedSet{TComponent}"/> and should be done either by using setting "useBuffer" of the available constructors to true or using an <see cref="Command.EntityCommandRecorder"/>.
/// </summary>
/// <typeparam name="TState">The type of the object used as state to update the system.</typeparam>
/// <typeparam name="TComponent">The type of the component to sort <see cref="Entity"/> by.</typeparam>
Expand Down

0 comments on commit 2d8f8bf

Please sign in to comment.