Home › Lua API › DealItem

Available out of the box. Usable from Lua in the unmodified game.

DealItem

37 methods. Symbol/current columns are function addresses (RVA) of the native wrapper.

Signatures are recovered from the game code. ⚠ = partly understood (arguments may be missing or approximate). ? after a name = optional argument. Types: integer/number are Lua numbers, enum-typed arguments show the C++ type in brackets. Two signatures mean the method is registered separately for the UI and the gameplay state and each wrapper was decoded on its own. "same code as" in the Symbol column means the compiler merged identical functions: those methods share one wrapper and cannot be told apart by address.

Method Signature Where Reference Symbol Current
GetAmount DealItem:GetAmount() → number gameplay — 0x6cf980 0x6d0020
GetDuration DealItem:GetDuration() → number
returns: The scripts pass the result to DealItem.SetDuration (parameter iDuration). (inferred)
gameplay — 0x6cf9d0 0x6d0070
GetEnactedTurn DealItem:GetEnactedTurn() → number gameplay — 0x6cfa20 0x6d00c0
GetEndTurn DealItem:GetEndTurn() → number gameplay — 0x6cfa70 0x6d0110
GetFromPlayerID DealItem:GetFromPlayerID() → number
returns: The scripts pass the result to Deal.AddItemOfType. (inferred)
gameplay — 0x6cfac0 0x6d0160
GetID DealItem:GetID() → number
returns: The scripts pass the result to Deal.RemoveItemByID (parameter uiID). (inferred)
gameplay — 0x6cfb10 0x6d01b0
GetMaxAmount DealItem:GetMaxAmount() → number gameplay — 0x6cfb60 —
GetMinAmount DealItem:GetMinAmount() → number gameplay — 0x6cfbb0 0x6d0250
GetParameterValue DealItem:GetParameterValue(arg1: number/string) → 1 values (or nothing) ⚠
args: arg1 — A string.
gameplay — 0x6cfc00 0x6d02a0
GetParentID DealItem:GetParentID() → number gameplay — 0x6cfca0 0x6d0340
GetPlayerIDs DealItem:GetPlayerIDs() → number, number gameplay — 0x6cfcf0 0x6d0390
GetSubType DealItem:GetSubType() → number
returns: The scripts pass the result to DealItem.SetSubType. (inferred)
gameplay — 0x6cfd60 0x6d0400
GetSubTypeID DealItem:GetSubTypeID() → nil/string (or nothing) gameplay — 0x6cfdb0 0x6d0450
GetSubTypeNameID DealItem:GetSubTypeNameID() → nil/string (or nothing) gameplay — 0x6cfe70 0x6d0510
GetToPlayerID DealItem:GetToPlayerID() → number gameplay — 0x6cff30 0x6d05d0
GetType DealItem:GetType() → number
returns: The scripts pass the result to Deal.AddItemOfType. (inferred)
gameplay — 0x6cff80 0x6d0620
GetValueCategory DealItem:GetValueCategory() → number gameplay — 0x6cffd0 —
GetValueType DealItem:GetValueType() → 1 values ⚠ gameplay — 0x6d0020 0x6d06c0
GetValueTypeID DealItem:GetValueTypeID() → nil/string (or nothing) gameplay — 0x6d0080 0x6d0720
GetValueTypeNameID DealItem:GetValueTypeNameID() → nil/string (or nothing) gameplay — 0x6d0140 0x6d07e0
HasPossibleAmounts DealItem:HasPossibleAmounts() → boolean gameplay — 0x6d0200 0x6d08a0
HasPossibleDurations DealItem:HasPossibleDurations() → boolean gameplay — 0x6d0250 0x6d08f0
HasPossibleValues DealItem:HasPossibleValues() → boolean gameplay — 0x6d02a0 0x6d0940
IsChild DealItem:IsChild() → boolean gameplay — 0x6d02f0 0x6d0990
IsExpired DealItem:IsExpired() → boolean gameplay — 0x6d0330 0x6d09d0
IsLocked DealItem:IsLocked() → boolean gameplay — 0x6d0380 0x6d0a20
IsUnacceptable DealItem:IsUnacceptable() → boolean gameplay — 0x6d03d0 0x6d0a70
IsValid DealItem:IsValid(pkResults: Deal) → number, boolean, number
args: pkResults — A Deal object (the scripts pass a variable named pDeal).
gameplay — 0x6d0420 0x6d0ac0
SetAmount DealItem:SetAmount(arg1: integer) (or nothing)
args: arg1 — A count or amount (named count / num / amount in the scripts). (inferred)
gameplay — 0x6d05a0 0x6d0c40
SetDuration DealItem:SetDuration(iDuration: integer) (or nothing) gameplay — 0x6d05f0 0x6d0c90
SetFromPlayerID DealItem:SetFromPlayerID(arg1?: number) (or nothing) gameplay — 0x6d0640 0x6d0ce0
SetLocked DealItem:SetLocked(arg1: boolean) (or nothing)
args: arg1 — A boolean flag (true/false).
gameplay — 0x6d06a0 0x6d0d40
SetParameterValue DealItem:SetParameterValue(arg1: number/string, arg2?: any) (or nothing) gameplay — 0x6d06f0 0x6d0d90
SetPlayerIDs DealItem:SetPlayerIDs(arg1?: number, arg2: number) (or nothing) gameplay — 0x6d0800 0x6d0ea0
SetSubType DealItem:SetSubType(arg1: integer) (or nothing)
args: arg1 — A constant from the Lua table DealAgreementTypes.
gameplay — 0x6d08a0 0x6d0f40
SetToPlayerID DealItem:SetToPlayerID(arg1?: number) (or nothing) gameplay — 0x6d08f0 0x6d0f90
SetValueType DealItem:SetValueType() → 1 values ⚠ gameplay — 0x6d0950 0x6d0ff0