Skip to content

Commit 38109e2

Browse files
Updated documentation
1 parent 5a61e3c commit 38109e2

File tree

4 files changed

+22
-16
lines changed

4 files changed

+22
-16
lines changed

Runtime/Attributes/Injected.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
namespace ElRaccoone.EntityComponentSystem {
22

3-
/// Describes a injectedable system of service.
3+
/// Describes a injectedable system, service or controller.
44
[System.AttributeUsage (System.AttributeTargets.Field)]
55
public class Injected : System.Attribute {
66

Runtime/Interfaces/IEntityComponent.cs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@ namespace ElRaccoone.EntityComponentSystem {
33
/// Base interface for every component
44
public interface IEntityComponent {
55

6-
/// ---
6+
/// During the 'InteralOnUpdate' the entity component will invoke its
7+
/// 'OnEntityEnabled' and 'OnEntityInitialized' if needed.
78
void Internal_OnUpdate ();
89
}
910
}

Runtime/Interfaces/IEntitySystem.cs

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,34 +3,37 @@ namespace ElRaccoone.EntityComponentSystem {
33
/// Base interface for every system
44
public interface IEntitySystem {
55

6-
/// ---
6+
/// Method invoked when the system will initialize.
77
void OnInitialize ();
88

9-
/// ---
9+
/// Method invoked when the system is initialized.
1010
void OnInitialized ();
1111

12-
/// ---
12+
// Method invoked when the system becomes enabled.
1313
void OnEnabled ();
1414

15-
/// ---
15+
// Method invoked when the system becomes disabled.
1616
void OnDisabled ();
1717

18-
/// ---
18+
/// Method invoked when the system updates, will be called every frame.
1919
void OnUpdate ();
2020

21-
/// ---
21+
// Method invoked before the system will update, return whether this system
22+
// should update. will be called every frame.
2223
bool ShouldUpdate ();
2324

24-
/// ---
25+
// Method invoked when the system is drawing the gizmos, will be called
26+
// every gizmos draw call.
2527
void OnDrawGizmos ();
2628

27-
/// ---
29+
// Method invoked when the system is drawing the gui, will be called every
30+
// on gui draw call.
2831
void OnDrawGui ();
2932

30-
/// ---
33+
/// Enables or disables this system.
3134
void SetEnabled (bool isEnabled);
3235

33-
/// ---
36+
/// Gets the enabled status of this system
3437
bool GetEnabled ();
3538

3639
/// Internal method to set the instance reference. This method will

Runtime/Interfaces/IService.cs

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,18 @@ namespace ElRaccoone.EntityComponentSystem {
33
/// Base interface for every service
44
public interface IService {
55

6-
/// ---
6+
/// Method invoked when the service will initialize.
77
void OnInitialize ();
88

9-
/// ---
9+
/// Method invoked when the system is initialized.
1010
void OnInitialized ();
1111

12-
/// ---
12+
// Method invoked when the service is drawing the gizmos, will be called
13+
// every gizmos draw call.
1314
void OnDrawGizmos ();
1415

15-
/// ---
16+
// Method invoked when the service is drawing the gui, will be called every
17+
// on gui draw call.
1618
void OnDrawGui ();
1719

1820
/// Internal method to set the instance reference. This method will

0 commit comments

Comments
 (0)