diff options
Diffstat (limited to 'docs/hooks-script.md')
| -rw-r--r-- | docs/hooks-script.md | 105 |
1 files changed, 53 insertions, 52 deletions
diff --git a/docs/hooks-script.md b/docs/hooks-script.md index f3885ef..3df1cfa 100644 --- a/docs/hooks-script.md +++ b/docs/hooks-script.md @@ -31,11 +31,13 @@ Don't worry! is not scary as you may think! Before going through the next step you should ask yourself: do I have to create a new script type based on `ScriptObject` class or can I reuse one of those already existing? -A script type is normally strictly related to a certain class of the core. For example: +A script type is normally strictly related to a certain class of the core. For example: + - `PlayerScript` -> `Player` class - `WorldScript` -> `World` class - `CreatureScript` -> `Creature` class -and so on. + +And so on. There are some exceptions such as the `GlobalScript` which is an Observer used in different classes throughout the core. But generally speaking, a script type should refer to a specific class. @@ -46,32 +48,33 @@ However, most of the time you just have to add new hooks to existing scripts, in ### 1) Standard procedure when adding new script type classes First of all, define the actual class, and have it inherit from ScriptObject, like so: - - ```cpp - class MyScriptType : public ScriptObject - { - uint32 _someId; - private: - void RegisterSelf(); - protected: - MyScriptType(const char* name, uint32 someId) - : ScriptObject(name), _someId(someId) - { - ScriptRegistry<MyScriptType>::AddScript(this); - } - public: - // If a virtual function in your script type class is not necessarily - // required to be overridden, just declare it virtual with an empty - // body. If, on the other hand, it's logical only to override it (i.e. - // if it's the only method in the class), make it pure virtual, by adding - // = 0 to it. - virtual void OnBeforeSomeEvent(uint32 /*someArg1*/, std::string& /*someArg2/*) { } - // This is a pure virtual function: - virtual void OnAnotherEvent(uint32 /*someArg*/) = 0; - } + +```cpp +class MyScriptType : public ScriptObject +{ + uint32 _someId; + private: + void RegisterSelf(); + protected: + MyScriptType(const char* name, uint32 someId) + : ScriptObject(name), _someId(someId) + { + ScriptRegistry<MyScriptType>::AddScript(this); + } + public: + // If a virtual function in your script type class is not necessarily + // required to be overridden, just declare it virtual with an empty + // body. If, on the other hand, it's logical only to override it (i.e. + // if it's the only method in the class), make it pure virtual, by adding + // = 0 to it. + virtual void OnBeforeSomeEvent(uint32 /*someArg1*/, std::string& /*someArg2/*) { } + // This is a pure virtual function: + virtual void OnAnotherEvent(uint32 /*someArg*/) = 0; +} ``` Next, you need to add a specialization for ScriptRegistry. Put this at the beginning of ScriptMgr.cpp: + ```cpp template class ScriptRegistry<MyScriptType>; ``` @@ -85,7 +88,7 @@ MyScriptType::MyScriptType(const char* name) ScriptRegistry<MyScriptType>::AddScript(this); } ``` - + Then add a cleanup routine in `ScriptMgr::unload()` ``` @@ -96,24 +99,20 @@ And finally your class is good to go with the script system! ### 2) Implement the hooks functions -If you didn't follow point 1 and you want to reuse an existing ScriptObject, then you have to declare the functions -within one of the pre-existing ScriptObject classes first (such as PlayerScript, ServerScript etc.) - +If you didn't follow point 1 and you want to reuse an existing ScriptObject, then you have to declare the functions within one of the pre-existing ScriptObject classes first (such as PlayerScript, ServerScript etc.) + #### Declare your hooks -What you need to do now is add functions to ScriptMgr that can be called from the core to actually trigger -certain events. -In ScriptMgr.h , inside the `class ScriptMgr` +What you need to do now is add functions to ScriptMgr that can be called from the core to actually trigger certain events. + +In ScriptMgr.h, inside the `class ScriptMgr` ```cpp void OnBeforeSomeEvent(uint32 someArg1, std::string& someArg2); void OnAnotherEvent(uint32 someArg); ``` -NOTE: for certain scripts the method declared inside the ScriptMgr class and the one declared into the related ScriptObject, -don't always match. For instance: `OnLogin` is a hook from the PlayerScript that is declared as `OnPlayerLogin` when -used inside the ScriptMgr class, thus avoid collisions with other methods since the ScriptMgr class collects hooks from all -the ScriptObjects within the same list. +**NOTE:** for certain scripts the method declared inside the ScriptMgr class and the one declared into the related ScriptObject, don't always match. For instance: `OnLogin` is a hook from the PlayerScript that is declared as `OnPlayerLogin` when used inside the ScriptMgr class, thus avoid collisions with other methods since the ScriptMgr class collects hooks from allnthe ScriptObjects within the same list. #### Define your hooks @@ -127,6 +126,7 @@ void ScriptMgr::OnBeforeSomeEvent(uint32 someArg1, std::string& someArg2) { FOREACH_SCRIPT(MyScriptType)->OnBeforeSomeEvent(someArg1, someArg2); } + void ScriptMgr::OnAnotherEvent(uint32 someArg) { FOREACH_SCRIPT(MyScriptType)->OnAnotherEvent(someArg); @@ -139,6 +139,7 @@ event on all registered scripts of that type. ### How to call your hooks The ScriptMgr class is initialized within the AC as a singleton that will contain all the observers (ScriptObjects) and their related registered listeners (hooks). + AC provides a global property called "sScriptMgr" that you can use to call your script within the AC functions. For instance: @@ -150,7 +151,7 @@ void CoreClass::SomeEvent() std::string arg2="something"; sScriptMgr->OnBeforeSomeEvent(arg1, arg2); - + //[...] } ``` @@ -159,9 +160,7 @@ void CoreClass::SomeEvent() Remember to document your new hook by following the [How to document your code](how-to-document-code.md) guide. -When you create a new hook to publish into the AC repo, one of the acceptance criteria is to write proper documentation for it, -hence other people know how to use it properly. So please, read that guide carefully. - +When you create a new hook to publish into the AC repo, one of the acceptance criteria is to write proper documentation for it, hence other people know how to use it properly. So please, read that guide carefully. ### Write a changelog @@ -180,20 +179,20 @@ For example: * `OnAfterArenaRatingCalculation` The action normally matches the name of the function within which the hook is called. -If the parent function is complex enough to even host different hooks, then the action -should reflect what the hook is used for. + +If the parent function is complex enough to even host different hooks, then the action should reflect what the hook is used for. The `[When]` part is optional, but strongly suggested. + It helps to understand in which part of the parent function the hook is called. -For instance, you can have both `OnBeforeConfigLoad` and `OnAfterConfigLoad`, -to change the behaviour before and after the config is loaded. + +For instance, you can have both `OnBeforeConfigLoad` and `OnAfterConfigLoad`, to change the behaviour before and after the config is loaded. ## Advanced hooks ### How to change the behaviour of a function (filtering) -With hooks you can't only run specific actions at a specific time, you can even change the behaviour of the function where the hook is called -To do so, you have 2 solutions: +With hooks you can't only run specific actions at a specific time, you can even change the behaviour of the function where the hook is called to do so, you have 2 solutions: #### 1) Using reference parameters @@ -202,7 +201,7 @@ For instance: ```cpp OnMotdChange(std::string& newMotd) -``` +``` Passing the newMotd with the '&' character you allow the listeners to change the value of the Motd when that action is called. @@ -214,6 +213,7 @@ This approach is not very common, most of the hooks return a "void" type, and wo bool ScriptMgr::OnBeforePlayerTeleport(Player* player, uint32 mapid, float x, float y, float z, float orientation, uint32 options, Unit* target) { bool ret = true; + FOR_SCRIPTS_RET(PlayerScript, itr, end, ret) // return true by default if not scripts if (!itr->second->OnBeforeTeleport(player, mapid, x, y, z, orientation, options, target)) ret = false; // we change ret value only when scripts return false @@ -223,24 +223,25 @@ bool ScriptMgr::OnBeforePlayerTeleport(Player* player, uint32 mapid, float x, fl ``` This hook notifies all the listeners but also catches when at least one of the registered listener returns "false", in that case the final return value will be false as well. + In this particular case, this hook is used within an if-condition to disallow a player to be teleported if one of the listeners returns **false** for some reason. You can implement your different logic (e.g. false by default, true if any) just remember to document it properly! ### Create your hook system within your module -By using the guide above you can even create your ScriptObject within your module to allow people to extend it. +By using the guide above you can even create your ScriptObject within your module to allow people to extend it. + Some modules, such as the auto-balance, allows customizing certain part of their function by using internal hooks You can take a look at this file as an example: https://github.com/azerothcore/mod-autobalance/blob/master/src/AutoBalance.h -NOTE: You also need to create your own ScriptMgr implementation and offer a singleton to allow calling your hooks. - +**NOTE:** You also need to create your own ScriptMgr implementation and offer a singleton to allow calling your hooks. ### Final considerations -There are different other features of the ScriptAI system that have not been included in this documentation, such as the creation of scripts bound -to specific entities inside our database (E.g. CreatureScript). This advanced usage can be implemented by replicate the related code we have inside the ScriptMgr files. +There are different other features of the ScriptAI system that have not been included in this documentation, such as the creation of scripts bound to specific entities inside our database (E.g. CreatureScript). This advanced usage can be implemented by replicate the related code we have inside the ScriptMgr files. + If you need any help or you want to improve this documentation, feel free to ask for support and edit this page. ## External resources |