Browse Source

Add info about overrides

Raphael Schmitz 2 years ago
parent
commit
79863a300d
1 changed files with 8 additions and 0 deletions
  1. 8 0
      en/manual/engine/entity-component-model/usage.md

+ 8 - 0
en/manual/engine/entity-component-model/usage.md

@@ -107,3 +107,11 @@ public class MyProcessor : EntityProcessor<MyComponent>
 By explicitly using `EntityProcessor<TComponent, TData>` instead, a different type can be chosen  
 By explicitly using `EntityProcessor<TComponent, TData>` instead, a different type can be chosen  
 for the actual data. This way, the `EntityComponent` can e.g. have "heavier" startup data and  
 for the actual data. This way, the `EntityComponent` can e.g. have "heavier" startup data and  
 references, while the data object that needs to be processed every frame can be kept small.
 references, while the data object that needs to be processed every frame can be kept small.
+
+This will require overriding a method `GenerateComponentData`, which produces a `TData` instance  
+from a `TComponent` instance.
+
+### Overrides
+`EntityProcessor` also provides several methods which can be overridden in order to react to certain events.  
+They are not overly complicated, so that their usage should be clear from their doc comments. 
+