mirror of
https://github.com/wesnoth/wesnoth
synced 2025-05-03 10:27:51 +00:00
695fa69238
The main reason for doing this, besides simplifying the code, is to avoid using the WML table dump __cfg, which is slow. This includes a change of the format in which the variables are stored, but since these are internal Micro AI utility functions, that does not matter. (cherry-picked from commit 133568efe6851944f0b9ddaaf75ccaff0cad6a4d)
51 lines
2.1 KiB
Lua
51 lines
2.1 KiB
Lua
-- This set of functions provides a consistent way of storing Micro AI
|
|
-- variables in units. Individual variables are stored inside a table with a
|
|
-- name specific to the MAI ('micro_ai-' .. ai_id). This table is removed when
|
|
-- the Micro AI is deleted in order to ensure that subsequent Micro AIs used
|
|
-- in the same scenario (or using the same units in later scenarios) work
|
|
-- correctly.
|
|
-- Note that, with this method, there can only ever be one of these tables for each
|
|
-- ai_id in each unit, but several tables are created for the same unit when there
|
|
-- are several Micro AIs with different ai_id values.
|
|
-- For the time being, we do not allow sub-tables. This is done because these
|
|
-- unit variables are required to be persistent across save-load cycles and
|
|
-- therefore need to be in WML table format. This could be extended to allow
|
|
-- sub-tables in WML format, but there is no need for that at this time.
|
|
|
|
local micro_ai_unit_variables = {}
|
|
|
|
function micro_ai_unit_variables.delete_mai_unit_variables(unit, ai_id)
|
|
unit.variables['micro_ai_' .. ai_id] = nil
|
|
end
|
|
|
|
function micro_ai_unit_variables.insert_mai_unit_variables(unit, ai_id, vars_table)
|
|
local mai_var = unit.variables['micro_ai_' .. ai_id] or {}
|
|
-- Restrict to top-level named fields
|
|
for k,v in pairs(vars_table) do mai_var[k] = v end
|
|
unit.variables['micro_ai_' .. ai_id] = mai_var
|
|
end
|
|
|
|
function micro_ai_unit_variables.set_mai_unit_variables(unit, ai_id, vars_table)
|
|
local mai_var = {}
|
|
-- Restrict to top-level named fields
|
|
for k,v in pairs(vars_table) do mai_var[k] = v end
|
|
unit.variables['micro_ai_' .. ai_id] = mai_var
|
|
end
|
|
|
|
function micro_ai_unit_variables.get_mai_unit_variables(unit, ai_id, key)
|
|
-- Get the content of [unit][variables]['micro_ai_' .. ai_id] tag
|
|
-- Return value:
|
|
-- - If tag is found: value of key if @key parameter is given, otherwise entire table
|
|
-- - If no such tag is found: nil if @key is given, otherwise empty table
|
|
|
|
local mai_var = unit.variables['micro_ai_' .. ai_id] or {}
|
|
|
|
if key then
|
|
return mai_var[key]
|
|
else
|
|
return mai_var
|
|
end
|
|
end
|
|
|
|
return micro_ai_unit_variables
|