JavaECS-Docs/docs/system/ECSSystem.md

66 lines
1.1 KiB
Markdown
Raw Normal View History

*| [JavaECS](../../README.md) | [docs](../overview.md) | [system](./dir.md) | ECSSystem[]().md*
2021-06-05 15:57:25 +12:00
# ECS System
2021-06-05 15:57:25 +12:00
| **In this Section** |
|-|
| [About](#about) |
| [Implementation](#implementation) |
| [Constructors](#constructors) |
| [Methods](#methods) |
| [Fields](#fields) |
## About
2021-06-05 15:57:25 +12:00
The `ECSSystem` class is intended to be extended by a more specific system implementation.
<br>
## Implementation
2021-06-05 15:43:27 +12:00
See [System.md](./System.md#implementation)
2021-06-05 15:57:25 +12:00
<br>
## Constructors
Default constructor
``` java
public ECSSystem(){}
```
<br>
## Methods
### init
``` java
public void init(){}
```
Functionality that needs to occur at the initialisation of the system should be performed here
* `init()` should be called only once, before the system is utilised
* An example of the type of call that could be made here is opening a file
<br>
### update
``` java
public void update(){}
```
Functionality that needs to be called regularly should be defined here
* `update()` is intended to be called regularly
<br>
## Fields
### entities
``` java
Set<Integer> entities = new HashSet<>();
```
The list of entities associated with this system
<br>
## Examples
<br>
## Notes