Skip to content

Commit b34c5b7

Browse files
Minor changes
1 parent c9604b1 commit b34c5b7

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -58,13 +58,13 @@ It's recommended to build your entire project around these life cycle methods.
5858

5959
### Controllers
6060

61-
**Introduction:** The Controller is the heart of your Application, each Application should consist of just one, commonly named the MainController. The Controller is the first entry point of the Entity Component System and is the place where all of your [Systems](#systems) and [Services](#services) are registered. Your Controller should be attached to a Game Object in your scene and will be marked to not be destroyed when switching scenes.
61+
**Introduction:** The [Controller](#controllers) is the heart of your Application, each Application should consist of just one, commonly named the MainController. The [Controller](#controllers) is the first entry point of the Entity Component System and is the place where all of your [Systems](#systems) and [Services](#services) are registered. Your [Controller](#controllers) should be attached to a Game Object in your scene and will be marked to not be destroyed when switching scenes.
6262

6363
```csharp
6464
public class MainController : Controller { }
6565
```
6666

67-
**Virtual On Initialize:** The Controller consists of an OnInitialize virtual method. This method can be overwritten and will be invoked during the very start of your Application. During this cycle properties with the Injected and Asset attribute are being assigned, it is important to invoke the Register method during this cycle since this is the only time in your Application you can register [Systems](#systems) and [Services](#services).
67+
**Virtual On Initialize:** The [Controller](#controllers) consists of an OnInitialize virtual method. This method can be overwritten and will be invoked during the very start of your Application. During this cycle properties with the Injected and Asset attribute are being assigned, it is important to invoke the Register method during this cycle since this is the only time in your Application you can register [Systems](#systems) and [Services](#services).
6868

6969
```csharp
7070
public class MainController : Controller {
@@ -77,23 +77,23 @@ public class MainController : Controller {
7777
}
7878
```
7979

80-
**Virtual On Initialized:** The Controller consists of an OnInitialized virtual method. This method can be overwritten and will be invoked when all [Systems](#systems) and [Services](#services) did initialize, and all the properties with the Injected and Asset attributes are assigned.
80+
**Virtual On Initialized:** The [Controller](#controllers) consists of an OnInitialized virtual method. This method can be overwritten and will be invoked when all [Systems](#systems) and [Services](#services) did initialize, and all the properties with the Injected and Asset attributes are assigned.
8181

8282
```csharp
8383
public class MainController : Controller {
8484
public override void OnInitialized () { }
8585
}
8686
```
8787

88-
**Virtual On Update:** The Controller consists of an OnUpdate virtual method. This method can be overwritten and will be invoked during the Update cycle. This cycle will run once every frame, the Controller's Update is invoked before the [System's](#systems) and [Service's](#services) update cycles.
88+
**Virtual On Update:** The [Controller](#controllers) consists of an OnUpdate virtual method. This method can be overwritten and will be invoked during the Update cycle. This cycle will run once every frame, the Controller's Update is invoked before the [System's](#systems) and [Service's](#services) update cycles.
8989

9090
```csharp
9191
public class MainController : Controller {
9292
public override void OnUpdate () { }
9393
}
9494
```
9595

96-
**Enabling Systems:** To enable or disable [Systems](#systems), the Controller contains of a method EnableSystem which allows [Systems](#systems) to stop their life cycle methods such as OnUpdate, OnPhysics, OnDrawGui and others. You can provide the [System's](#system) type using a generic.
96+
**Enabling Systems:** To enable or disable [Systems](#systems), the [Controller](#controllers) contains of a method EnableSystem which allows [Systems](#systems) to stop their life cycle methods such as OnUpdate, OnPhysics, OnDrawGui and others. You can provide the [System's](#system) type using a generic.
9797

9898
```csharp
9999
public class MainController : Controller {
@@ -104,7 +104,7 @@ public class MainController : Controller {
104104
}
105105
```
106106

107-
**Checking Whether Systems Are Enabled:** To check whether [Systems](#systems) are enable or disabled, the Controller contains of a method IsSystemEnabled. Invoking the method will return a boolean informing if the [System](#systems) is enabled or not. You can provide the [System's](#system) type using a generic.
107+
**Checking Whether Systems Are Enabled:** To check whether [Systems](#systems) are enable or disabled, the [Controller](#controllers) contains of a method IsSystemEnabled. Invoking the method will return a boolean informing if the [System](#systems) is enabled or not. You can provide the [System's](#system) type using a generic.
108108

109109
```csharp
110110
public class MainController : Controller {
@@ -114,7 +114,7 @@ public class MainController : Controller {
114114
}
115115
```
116116

117-
**Injection:** The Controller allows the use of the Injected attribute on properties to automatically assign the values of referenced [Systems](#Systems) and [Services](#Services), making all public methods and properties accessible. These properties are assigned during the OnInitialize cycle and are available for use at the OnInitialized cycle.
117+
**Injection:** The [Controller](#controllers) allows the use of the Injected attribute on properties to automatically assign the values of referenced [Systems](#Systems) and [Services](#Services), making all public methods and properties accessible. These properties are assigned during the OnInitialize cycle and are available for use at the OnInitialized cycle.
118118

119119
```csharp
120120
public class MainController : Controller {
@@ -123,7 +123,7 @@ public class MainController : Controller {
123123
}
124124
```
125125

126-
**Notes:** While it is recommended to move as much logic into [Services](#services) and [Systems](#systems), it is possible to let your Controller house any functionality. If you use the Controller for this purpose, try to keep it down to only Application wide and core functionality.
126+
**Notes:** While it is recommended to move as much logic into [Services](#services) and [Systems](#systems), it is possible to let your [Controller](#controllers) house any functionality. If you use the [Controller](#controllers) for this purpose, try to keep it down to only Application wide and core functionality.
127127

128128
### Systems
129129

0 commit comments

Comments
 (0)