Module ARTSET_SCRIPT_INTERFACE
Art set userdata for character portraits and cultural variations.
Functions
| GetAgent () | Allocated agent type key (e.g. |
| GetCulture () | Allocated culture key for this art set (e.g. |
| GetFaction () | Allocated faction key for this art set (e.g. |
| GetGroup () | Campaign group key from campaign_character_art_set_groups_tables (e.g. |
| GetKey () | Art set record key ID from campaign_character_art_sets_tables (e.g. |
| GetPortraitPath () | Resolved 2D portrait diffuse PNG file path used by the UI. |
| GetSettingsId () | Unique 3D portrait camera settings ID string (e.g. |
| GetSubculture () | Allocated subculture key for this art set (e.g. |
| HasAging () | Checks whether this art set supports visual aging stages (young, middle-aged, old). |
| HasHealth () | Checks whether this art set supports health/wound visual variations. |
| HasLevelling () | Checks whether this art set supports rank-based visual upgrades (improved armor/regalia with character rank). |
| HasReligion () | Checks whether this art set supports religious visual variations. |
| HasSeasonal () | Checks whether this art set supports seasonal visual variations (winter furs/gear). |
| IsCustom () | Checks whether this art set is a custom unique set (e.g. |
| IsFactionLeaderSet () | Checks whether this art set is specifically configured for faction leaders (e.g. |
| IsMale () | Checks whether this art set represents a male character model. |
Functions
- GetAgent ()
-
Allocated agent type key (e.g.
"general","champion","spy","dignitary").Returns:
-
string
agent database key
Usage:
if art_set:GetAgent() == "general" then -- Art set is designed for army commanders end
- GetCulture ()
-
Allocated culture key for this art set (e.g.
"att_cult_nomadic","att_cult_roman").Returns:
-
string
culture database key
Usage:
local culture = art_set:GetCulture()
- GetFaction ()
-
Allocated faction key for this art set (e.g.
"att_fact_hunni"), or empty string if culture-wide.Returns:
-
string
faction database key
Usage:
local faction_key = art_set:GetFaction()
- GetGroup ()
-
Campaign group key from
campaign_character_art_set_groups_tables(e.g."main"), or empty string if none.Returns:
-
string
campaign group key
Usage:
local group_key = art_set:GetGroup()
- GetKey ()
-
Art set record key ID from
campaign_character_art_sets_tables(e.g."att_huns_general_01","att_general_nomadic_16").Returns:
-
string
art set record key
Usage:
local art_key = art_set:GetKey()
- GetPortraitPath ()
-
Resolved 2D portrait diffuse PNG file path used by the UI.
Returns:
-
string
portrait diffuse file path (e.g.
"UI/Portraits/Portholes/att_cult_nomadic/att_frontend_faction_leader_huns_0.png")Usage:
local png_path = art_set:GetPortraitPath()
- GetSettingsId ()
-
Unique 3D portrait camera settings ID string (e.g.
"att_huns_general_010").Returns:
-
string
portrait settings unique identifier
Usage:
local cam_id = art_set:GetSettingsId()
- GetSubculture ()
-
Allocated subculture key for this art set (e.g.
"att_sub_cult_nomadic_hunnic").Returns:
-
string
subculture database key
Usage:
local subculture = art_set:GetSubculture()
- HasAging ()
-
Checks whether this art set supports visual aging stages (young, middle-aged, old).
Returns:
-
boolean
true if aging variations are enabled
Usage:
local has_aging = art_set:HasAging()
- HasHealth ()
-
Checks whether this art set supports health/wound visual variations.
Returns:
-
boolean
true if health variation is enabled
Usage:
local has_health = art_set:HasHealth()
- HasLevelling ()
-
Checks whether this art set supports rank-based visual upgrades (improved armor/regalia with character rank).
Returns:
-
boolean
true if levelling variations are enabled
Usage:
local has_levelling = art_set:HasLevelling()
- HasReligion ()
-
Checks whether this art set supports religious visual variations.
Returns:
-
boolean
true if religion variation is enabled
Usage:
local has_religion = art_set:HasReligion()
- HasSeasonal ()
-
Checks whether this art set supports seasonal visual variations (winter furs/gear).
Returns:
-
boolean
true if seasonal variations are enabled
Usage:
local has_seasonal = art_set:HasSeasonal()
- IsCustom ()
-
Checks whether this art set is a custom unique set (e.g. Attila or historical general).
Returns:
-
boolean
true if this is a custom unique art set, false otherwise
Usage:
if art_set:IsCustom() then -- Unique historical art set end
- IsFactionLeaderSet ()
-
Checks whether this art set is specifically configured for faction leaders (e.g. wearing crowns/diadems).
Returns:
-
boolean
true if configured as a faction leader art set
Usage:
if art_set:IsFactionLeaderSet() then -- Character wears regal faction leader visual assets end
- IsMale ()
-
Checks whether this art set represents a male character model.
Returns:
-
boolean
true if male, false if female
Usage:
local is_male = art_set:IsMale()