chadvandy / tw_autogen Goto Github PK

ie. remove the assumption of class and :

easier pointing for the extension - warhammer3/ as a library for a fully global mod, or warhammer3/global warhammer3/battle for a battle mod, etc.

Some functions like those in common, wh3/battle/common.lua and validate, wh3/battle/validate.lua should use "." instead of ":". These are generated files.

With ":", Lua passes in self as the first argument. So currently we get cryptic warnings like "the function received at least 3 arguments, but got 2" when using these functions correctly.

if in all three, toss it into game/global/
if in two or less, toss it into game/%context%/, where context is campaign/battle/frontend

--- Calls a specified function on a specified context object that makes changes to the game. This allows script to use the context system to modify the state of the game.
---@param object_id string default value="CcoScriptObject" Context object id on which to call the function. If omitted, the function is called on the CcoScriptObject object.
---@param construction_data string|integer specifies which CCO should be retrieved, for example for Characters this would be the CQI.
---@param function_id string #Function id on the context object to call. This can also be an expression, but the result must return a context id.
function common.call_context_command(object_id, construction_data, function_id) end

--- Calls a specified function on a specified context object that makes changes to the game. This allows script to use the context system to modify the state of the game.
---@param function_id string #Function id on the context object to call on the CcoScriptObject
function common.call_context_command(function_id) end

---@param object_id string default value="CcoScriptObject" Context object id on which to call the function. If omitted, the function is called on the CcoScriptObject object.
---@param construction_data string|integer specifies which CCO should be retrieved, for example for Characters this would be the CQI.
---@param function_id string #Function id on the context object to call. This can also be an expression, but the result must return a context id.
---@return any
function common.get_context_value(object_id, construction_data, function_id) end

--- Will look up the context object from the context cache or construct one with the type "context_object_typename" and the data (usually a CQI) from "construction_data", call the context function specified by context_function_id and return the value.
---@param function_id string #Function id on the context object to call on the CcoScriptObject
---@return any
function common.get_context_value(function_id) end

--- Finds and returns a uicomponent based on a set of strings that define its path in the ui hierarchy. This parent uicomponent can be supplied as the first argument - if omitted, the root uicomponent is used. Starting from the parent or root, the function searches through all descendants for a uicomponent with the next supplied uicomponent name in the sequence. If a uicomponent is found, its descendants are then searched for a uicomponent with the next name in the list, and so on until the list is finished or no uicomponent with the supplied name is found. A fragmentary path may be supplied if it still unambiguously specifies the intended uicomponent.
---@param parent_ui_component UIC|string parent ui component
---@vararg any
---@return UIC
function find_uicomponent(parent_ui_component, ...) end

stupid

ie. core, UIComponent

ie. use the DF method structure than the current do-end gore

This issue is new in commit b1f747a (links to the diff)

In battle_manager, many incorrect return values with undefined types are being added to get_camera_distance_travelled. These come from a list in the Engagement Monitor documentation that comes right after that function in the html file for battle_manager.

for instance, battle_unit:can_use_magic(), or battle_manager:get_camera_distance_travelled()

Many functions, including table.copy and table.contains.

Should all of these be manually added to all.lua?

ie. search for "[^%s]" for "everything but a space" instead of searching for very specific wild cards