Browse Source

Fix documentation of Module.

tags/v2.0.0
Andrew Belt 4 years ago
parent
commit
79ee967210
1 changed files with 2 additions and 2 deletions
  1. +2
    -2
      include/engine/Module.hpp

+ 2
- 2
include/engine/Module.hpp View File

@@ -269,13 +269,13 @@ struct Module {


struct ResetEvent {}; struct ResetEvent {};
/** Called when the user resets (initializes) the module. /** Called when the user resets (initializes) the module.
The default implementation resets all parameters to their default value, so you must call `Module::onRandomize(e)` if you want to keep this behavior.
The default implementation resets all parameters to their default value, so you must call `Module::onReset(e)` in your overridden method if you want to keep this behavior.
*/ */
virtual void onReset(const ResetEvent& e); virtual void onReset(const ResetEvent& e);


struct RandomizeEvent {}; struct RandomizeEvent {};
/** Called when the user randomizes the module. /** Called when the user randomizes the module.
The default implementation randomizes all parameters by default, so you must call `Module::onRandomize(e)` if you want to keep this behavior.
The default implementation randomizes all parameters by default, so you must call `Module::onRandomize(e)` in your overridden method if you want to keep this behavior.
*/ */
virtual void onRandomize(const RandomizeEvent& e); virtual void onRandomize(const RandomizeEvent& e);




Loading…
Cancel
Save