Editing Mod Hooks
Warning: You are not logged in.
Your IP address will be recorded in this page's edit history.The edit can be undone.
Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.
Latest revision | Your text | ||
Line 1: | Line 1: | ||
− | + | WarLight will call into a [[Mods|mod's]] lua code using what are called '''hooks'''. | |
For example, it will call a hook named Server_StartGame when a game is beginning and give your mod an opportunity to change things about how the map is set up. | For example, it will call a hook named Server_StartGame when a game is beginning and give your mod an opportunity to change things about how the map is set up. | ||
Line 5: | Line 5: | ||
If you provide a function with the name listed here, and in a file with the name listed here, it will be called as explained. Note that both the function name and the file name are case-sensitive. | If you provide a function with the name listed here, and in a file with the name listed here, it will be called as explained. Note that both the function name and the file name are case-sensitive. | ||
− | == | + | == Hook Reference == |
− | *Server_Created (Server_Created.lua) | + | * Server_Created (Server_Created.lua) |
** Called in every game when the game is first created. In multi-player, this means it's called before players even accept or join the request for the game. This is the only place that game settings can be changed. | ** Called in every game when the game is first created. In multi-player, this means it's called before players even accept or join the request for the game. This is the only place that game settings can be changed. | ||
** Return value: None. | ** Return value: None. | ||
Line 30: | Line 30: | ||
# [[Mod API Reference:GameStanding|Standing]]: (writable) Allows your mod to change the the standing before players see it. For example, a mod could change the number of armies on any territory, control which players control which territories, or define what cards each player starts with. | # [[Mod API Reference:GameStanding|Standing]]: (writable) Allows your mod to change the the standing before players see it. For example, a mod could change the number of armies on any territory, control which players control which territories, or define what cards each player starts with. | ||
+ | |||
+ | * Client_PresentConfigureUI (Client_PresentConfigureUI.lua) | ||
+ | ** Called when a player checks your mod on the Create Game page. If your mod has any configurable settings, you should create UI controls on the screen to allow players to configure them using the [[Mod API Reference:UI|UI API]]. Mods should also check the <code>Mod.Settings</code> global to see if any settings are already defined, and if they are, default their UI state to match that. | ||
+ | ** Arguments: | ||
+ | # rootParent: Pass this as an argument to the top-level UI element your mod creates. See the [[Mod API Reference:UI|UI API]] for details. | ||
+ | |||
+ | |||
+ | * Client_SaveConfigureUI (Client_SaveConfigureUI.lua) | ||
+ | ** Called when a player submits the Create Game Mod page with your mod checked. If your mod presented any UI in Client_PresentConfigureUI, your mod should persist any settings into the <code>Mod.Settings</code> global during this hook. This is the only place that <code>Mod.Settings</code> should ever be written to. | ||
+ | ** Arguments: | ||
+ | # alert: A function callback that takes a string. If the user has configured anything wrong with your UI, you can call this to notify them of their mistake. Calling this function will also abort the save. | ||
+ | |||
+ | |||
+ | * Client_PresentSettingsUI (Client_PresentSettingsUI.lua) | ||
+ | ** Called when a player opens the Game Settings panel of a game that has your mod included. If your mod has any configurable settings, you should read them out of the global <code>Mod.Settings</code> and show them to the player here using the [[Mod API Reference:UI|UI API]]. | ||
+ | ** Arguments: | ||
+ | # rootParent: Pass this as an argument to the top-level UI element your mod creates. See the [[Mod API Reference:UI|UI API]] for details. | ||
* Server_AdvanceTurn_Start (Server_AdvanceTurn.lua) | * Server_AdvanceTurn_Start (Server_AdvanceTurn.lua) | ||
− | ** Called whenever the server begins processing a normal turn (not territory picking). This gives mods an opportunity to insert orders at the start of a turn, before any player's orders are added. All of the Server_AdvanceTurn_* | + | ** Called whenever the server begins processing a normal turn (not territory picking). This gives mods an opportunity to insert orders at the start of a turn, before any player's orders are added. All of the Server_AdvanceTurn_* turns share global state within a single turn, so global variables can be read and written reliably by mods. |
** Arguments: | ** Arguments: | ||
# [[Mod API Reference:Game|Game]]: Provides read-only information about the game. | # [[Mod API Reference:Game|Game]]: Provides read-only information about the game. | ||
− | # addNewOrder: A function that you can call to add a [[Mod API Reference:GameOrder|GameOrder]] to the start of the turn | + | # addNewOrder: A function that you can call to add a [[Mod API Reference:GameOrder|GameOrder]] to the start of the turn. Pass a single GameOrder as the only argument to this function. You may call this function multiple times if you wish. |
− | + | ||
− | + | ||
− | + | ||
Line 52: | Line 66: | ||
## WL.ModOrderControl.Skip: Indicates this order should be skipped. It won't appear in the orders list at all and it will be as if the order never existed. A [[Mod API Reference:GameOrderEvent|GameOrderEvent]] will be written into the orders list to tell the player who entered this order that their order was skipped. | ## WL.ModOrderControl.Skip: Indicates this order should be skipped. It won't appear in the orders list at all and it will be as if the order never existed. A [[Mod API Reference:GameOrderEvent|GameOrderEvent]] will be written into the orders list to tell the player who entered this order that their order was skipped. | ||
## WL.ModOrderControl.SkipAndSupressSkippedMessage: Same as Skip, except that the GameOrderEvent is not written. This should be used with care, as players will want to know why their order didn't appear in the orders list. This should only be used if you use some other mechanism to explain to the player why their order was not present, or if this is an order that your mod inserted and therefore no players were expecting it. | ## WL.ModOrderControl.SkipAndSupressSkippedMessage: Same as Skip, except that the GameOrderEvent is not written. This should be used with care, as players will want to know why their order didn't appear in the orders list. This should only be used if you use some other mechanism to explain to the player why their order was not present, or if this is an order that your mod inserted and therefore no players were expecting it. | ||
− | # addNewOrder: A function that you can call to add a [[Mod API Reference:GameOrder|GameOrder]] to the | + | # addNewOrder: A function that you can call to add a [[Mod API Reference:GameOrder|GameOrder]] to the end of the turn. Pass a single GameOrder as the only argument to this function. You may call this function multiple times if you wish. |
Line 59: | Line 73: | ||
** Arguments: | ** Arguments: | ||
# [[Mod API Reference:Game|Game]]: Provides read-only information about the game. | # [[Mod API Reference:Game|Game]]: Provides read-only information about the game. | ||
− | # addNewOrder: A function that you can call to add a [[Mod API Reference:GameOrder|GameOrder]] to the | + | # addNewOrder: A function that you can call to add a [[Mod API Reference:GameOrder|GameOrder]] to the end of the turn. Pass a single GameOrder as the only argument to this function. You may call this function multiple times if you wish. |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
== Notes == | == Notes == | ||
Line 119: | Line 82: | ||
− | No hooks have return values. Meaning, it doesn't matter if you return any values from your hook functions. Instead, the mod framework gives you callbacks to call to affect things. This is preferred over return values for a few reasons. First, it allows mods to call the callbacks early on or late on in their function, which can be easier than a return statement which must come at the end. Second, it allows mods to simply not call the callback, which can signal to | + | No hooks have return values. Meaning, it doesn't matter if you return any values from your hook functions. Instead, the mod framework gives you callbacks to call to affect things. This is preferred over return values for a few reasons. First, it allows mods to call the callbacks early on or late on in their function, which can be easier than a return statement which must come at the end. Second, it allows mods to simply not call the callback, which can signal to WarLight that the mod doesn't care about the result of this. This can be important in some cases where multiple mods that define the same hook. Sometimes the mods instructions can conflict and WarLight must decide which to obey. |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + |