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*
# Implementation
### Contents
[Steps](#steps)
[Example](#example)
| **Contents** |
|-|
| [Steps](#steps) |
| [Example](#example) |
## Steps
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:
[entity](./entity/entity.md)
[component](./component/component.md)
[system](./system/system.md)
| **See also:** |
|-|
|[Entity](./entity/Entity.md) |
|[Component](./component/Component.md)|
|[System](./system/System.md)|

22
docs/overview.md
View File

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

29
docs/system/ECSSystem.md
View File

@ -1,27 +1,26 @@
*| [JavaECS](../../README.md) | [docs](../overview.md) | [system](./dir.md) | ECSSystem[]().md*
# System Manager
# ECS System
### In this section
[About](#about)
| **In this Section** |
|-|
| [About](#about) |
| [Implementation](#implementation) |
| [Constructors](#constructors) |
| [Methods](#methods) |
| [Fields](#fields) |
[Implementation](#implementation)
[Constructors](#constructors)
[Methods](#methods)
[Fields](#fields)
[Examples](#examples)
[Notes](#notes)
## 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
See [System.md](./System.md#implementation)
<br>
## Constructors
Default constructor
``` java

16
docs/system/System.md
View File

@ -1,15 +1,11 @@
*| [JavaECS](../../README.md) | [docs](../overview.md) | [system](./dir.md) | System[]().md*
# System
### In this section
[About](#about)
[Implementation](#implementation)
[Examples](#examples)
[Notes](#notes)
| **In this section** |
|-|
| [About](#about) |
| [Implementation](#implementation)|
| [Examples](#examples)|
| [Notes](#notes) |
## About
>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*
# System Manager
### In this section
[About](#about)
[Implementation](#implementation)
[Constructors](#constructors)
[Methods](#methods)
[Fields](#fields)
[Examples](#examples)
[Notes](#notes)
| **In this Section** |
|-|
| [About](#about) |
| [Implementation](#implementation) |
| [Constructors](#constructors) |
| [Methods](#methods) |
| [Fields](#fields) |
| [Examples](#examples)|
| [Notes](#notes)|
## About
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*
# Overview
### In this folder
* [ECSSystem.md](./ECSSystem.md)
* [System.md](./System.md)
* [SystemManager.md](./SystemManager.md)
| **In this folder** |
|-|
| [ECSSystem.md](./ECSSystem.md) |
| [System.md](./System.md) |
| [SystemManager.md](./SystemManager.md) |