BrychanD/JavaECS-Docs
1
0
Fork 0
Code Issues 1 Pull Requests Projects Releases Wiki Activity

Switched to tables

Browse Source
This commit is contained in:
Brychan Dempsey 2021-06-05 15:57:25 +12:00
parent 289a036cea
commit c28428cacd
6 changed files with 53 additions and 69 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
docs/implementation.md
View File

@ -1,9 +1,9 @@
*| [JavaECS](../README.md) | [docs](./overview.md) | implementation[]().md* *| [JavaECS](../README.md) | [docs](./overview.md) | implementation[]().md*
# Implementation # Implementation
### Contents | **Contents** |
[Steps](#steps) |-|
| [Steps](#steps) |
[Example](#example) | [Example](#example) |
## Steps ## Steps
1. In the application's setup function, create an instance of `ECS`, with a specified maximum number of entity entries. 1. In the application's setup function, create an instance of `ECS`, with a specified maximum number of entity entries.
@ -51,11 +51,8 @@ class ridgidBody{
} }
``` ```
| **See also:** |
|-|
### See also: |[Entity](./entity/Entity.md) |
[entity](./entity/entity.md) |[Component](./component/Component.md)|
|[System](./system/System.md)|
[component](./component/component.md)
[system](./system/system.md)

22
docs/overview.md
View File

@ -1,16 +1,14 @@
*| [JavaECS](../README.md) | docs* *| [JavaECS](../README.md) | docs*
# Overview # Overview
### In this folder | **In this folder** |
[Implementation](./implementation.md) *how to use JavaECS* |-|
|[Implementation](./implementation.md) *how to use JavaECS*|
### See also: | **See also:** |
[Entity](./entity/Entity.md) |-|
|[Entity](./entity/Entity.md) |
[Component](./component/Component.md) |[Component](./component/Component.md)|
|[System](./system/System.md)|
[System](./system/System.md) |[event](./)|
|[GameEngine](./)|
[event](./)
[GameEngine](./)

29
docs/system/ECSSystem.md
View File

@ -1,27 +1,26 @@
*| [JavaECS](../../README.md) | [docs](../overview.md) | [system](./dir.md) | ECSSystem[]().md* *| [JavaECS](../../README.md) | [docs](../overview.md) | [system](./dir.md) | ECSSystem[]().md*
# System Manager # ECS System
### In this section | **In this Section** |
[About](#about) |-|
| [About](#about) |
| [Implementation](#implementation) |
| [Constructors](#constructors) |
| [Methods](#methods) |
| [Fields](#fields) |
[Implementation](#implementation)
[Constructors](#constructors)
[Methods](#methods)
[Fields](#fields)
[Examples](#examples)
[Notes](#notes)
## About ## About
The system manager class controls references to the systems. The `ECSSystem` class is intended to be extended by a more specific system implementation.
<br>
## Implementation ## Implementation
See [System.md](./System.md#implementation) See [System.md](./System.md#implementation)
<br>
## Constructors ## Constructors
Default constructor Default constructor
``` java ``` java

16
docs/system/System.md
View File

@ -1,15 +1,11 @@
*| [JavaECS](../../README.md) | [docs](../overview.md) | [system](./dir.md) | System[]().md* *| [JavaECS](../../README.md) | [docs](../overview.md) | [system](./dir.md) | System[]().md*
# System # System
| **In this section** |
### In this section |-|
[About](#about) | [About](#about) |
| [Implementation](#implementation)|
[Implementation](#implementation) | [Examples](#examples)|
| [Notes](#notes) |
[Examples](#examples)
[Notes](#notes)
## About ## About
>A system is a functionality that is executed regularly by the game engine. >A system is a functionality that is executed regularly by the game engine.

25
docs/system/SystemManager.md
View File

@ -1,21 +1,14 @@
*| [JavaECS](../../README.md) | [docs](../overview.md) | [system](./dir.md) | SystemManager[]().md* *| [JavaECS](../../README.md) | [docs](../overview.md) | [system](./dir.md) | SystemManager[]().md*
# System Manager # System Manager
| **In this Section** |
### In this section |-|
[About](#about) | [About](#about) |
| [Implementation](#implementation) |
[Implementation](#implementation) | [Constructors](#constructors) |
| [Methods](#methods) |
[Constructors](#constructors) | [Fields](#fields) |
| [Examples](#examples)|
[Methods](#methods) | [Notes](#notes)|
[Fields](#fields)
[Examples](#examples)
[Notes](#notes)
## About ## About
The system manager class controls references to the systems. The system manager class controls references to the systems.

9
docs/system/dir.md
View File

@ -1,6 +1,7 @@
*| [JavaECS](../README.md) | [docs](../overview.md) | system* *| [JavaECS](../README.md) | [docs](../overview.md) | system*
# Overview # Overview
### In this folder | **In this folder** |
* [ECSSystem.md](./ECSSystem.md) |-|
* [System.md](./System.md) | [ECSSystem.md](./ECSSystem.md) |
* [SystemManager.md](./SystemManager.md) | [System.md](./System.md) |
| [SystemManager.md](./SystemManager.md) |