Skip to content

Commit e7e7404

Browse files
committed
Update documentation
1 parent a26e6bd commit e7e7404

File tree

5 files changed

+17
-5
lines changed

5 files changed

+17
-5
lines changed

Documentation~/articles/data-structures.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@ slug: "/manual/data-structures"
44

55
# Data Structures
66

7-
The **Architecture Toolkit** contains various data structures that may be useful throughout a project. All of the following data structures are available in the package:
7+
The **Architecture Toolkit** contains various data structures that may be useful throughout a project. The following data structures are available in the package:
8+
9+
<br/>
810

911
## Accumulators
1012

@@ -22,6 +24,8 @@ Supported types:
2224
- [Vector3Int](/api/Zigurous.Architecture/Vector3IntAccumulator)
2325
- [Vector4](/api/Zigurous.Architecture/Vector4Accumulator)
2426

27+
<hr/>
28+
2529
## Ranges
2630

2731
Ranges allow you to specify a lower and upper bound which can then be used for a multitude of purposes including clamping values, interpolating numbers, generating random values, and more.
@@ -43,12 +47,14 @@ Included types:
4347
- [Vector3IntRange](/api/Zigurous.Architecture/Vector3IntRange)
4448
- [Vector4Range](/api/Zigurous.Architecture/Vector4Range)
4549

50+
<hr/>
51+
4652
## Misc
4753

4854
- [Bitmask](/api/Zigurous.Architecture/Bitmask) - A bitmask representation that can be used for bitwise operations.
4955
- [Bool3](/api/Zigurous.Architecture/Bool3) - Stores a tuple of 3 booleans
5056
- [GridSize](/api/Zigurous.Architecture/GridSize) - Stores the size of a grid as rows and columns.
5157
- [Quantity\<T\>](/api/Zigurous.Architecture/Quantity-1) - Stores a quantity of a given entity type
52-
- [Registry\<T\>](/api/Zigurous.Architecture/RegisteredList-1) - Manages a list of unique items and invokes callbacks when an item is added or removed from the list.
58+
- [Registry\<T\>](/api/Zigurous.Architecture/Registry-1) - Manages a list of unique items and invokes callbacks when an item is added or removed from the list.
5359
- [RuntimeSet\<T\>](/api/Zigurous.Architecture/RuntimeSet-1) - A ScriptableObject that stores a list of items. A project asset can be created for the runtime set so it can be referenced throughout the application, but the items are added and removed at runtime.
5460
- [Size](/api/Zigurous.Architecture/Size) - Stores the size of an entity as a width and height

Documentation~/articles/events.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,20 @@ slug: "/manual/events"
66

77
Events are powerful tool provided by Unity. The **Architecture Toolkit** extends this system by allowing events to be saved as ScriptableObjects. This means the same event can be referenced and listened to by multiple systems throughout the project.
88

9+
<br/>
10+
911
### Game Event
1012

1113
An event can be created through the Asset menu, `Zigurous > Events > Game Event`. There are no properties on an event, but they can be extended further with subclasses if needed. See the [GameEvent](/api/Zigurous.Architecture/GameEvent) Scripting API.
1214

15+
<hr/>
16+
1317
### Game Event Listener
1418

1519
A [GameEventListener](/api/Zigurous.Architecture/GameEventListener) component can be added to any game object that needs to listen for an event. This is a class that derives from `MonoBehaviour` and will register and unregister itself as a listener for the specified event. The listener also declares a standard `UnityEvent` response property that is invoked when the event is raised.
1620

21+
<hr/>
22+
1723
### Event Reference
1824

1925
The [EventReference](/api/Zigurous.Architecture/EventReference) class allows a `UnityEvent` or `GameEvent` to be referenced. The option to switch between the two choices is available in the editor. Anywhere you might declare a variable as a `UnityEvent` or a `GameEvent` consider declaring it as an `EventReference` for more flexibility.

Documentation~/articles/extensions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ slug: "/manual/extensions"
44

55
# Extension Methods
66

7-
The **Architecture Toolkit** contains hundreds of extension methods that provide enhanced support for common container types and Unity classes. Extension methods are available for the following types:
7+
The **Architecture Toolkit** contains hundreds of extension methods to provide enhanced support for common container types and Unity classes. See the Scripting API for more information:
88

99
#### [Array](/api/Zigurous.Architecture/ArrayExtensions)
1010

Documentation~/articles/scriptable-variables.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
slug: "/manual/variables"
2+
slug: "/manual/scriptable-variables"
33
---
44

55
# Scriptable Variables

Runtime/Variables/ScriptableVariable.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ namespace Zigurous.Architecture
55
/// <summary>
66
/// A variable type that derives from ScriptableObject.
77
/// </summary>
8-
/// <typeparam name="T">The type of value.<typeparam>
8+
/// <typeparam name="T">The type of value.</typeparam>
99
public abstract class ScriptableVariable<T> : ScriptableObject
1010
{
1111
/// <summary>

0 commit comments

Comments
 (0)