Skip to content

SetStoreFlag.md

Latest commit

 

History

History
101 lines (77 loc) · 3.77 KB

SetStoreFlag.md

File metadata and controls

101 lines (77 loc) · 3.77 KB
Raw

SetStoreFlag — ACTION.IDS 481

Synopsis

SetStoreFlag(S:Store*,I:Flag*Stoflag,I:SetReset*Boolean)

Instant action. Sets or clears one bit in the store header flags dword (STO offset 0x0010 / CStore.m_header.m_nStoreFlags), then marshals the store so the change is written into the game temp tree and included in subsequent save games — even when inventory is unchanged.

Parameters

Param Type Meaning
Store resref STO filename (with or without .STO)
Flag 0–31 Bit index in the flags dword (STOFLAG.IDS)
SetReset Boolean TRUE/1 set the bit; FALSE/0 clear it

Flag bits (STOFLAG.IDS)

Bit Name Meaning
0 BUY User allowed to buy
1 SELL User allowed to sell
2 IDENTIFY User allowed to identify
3 STEAL User allowed to steal
4 DONATE User allowed to donate
5 CURES User allowed to purchase cures
6 DRINKS User allowed to purchase drinks
9 QUALITY1 Tavern quality bit 1
10 QUALITY2 Tavern quality bit 2
12 FENCE Buy fenced goods
13 REPUTATION Reputation does not affect prices (BGEE)
14 RECHARGE Toggle item recharge (TobEx)
15 CRITICAL User allowed to sell critical items (BGEE)

Bits 7, 8, and 11 are unused/unknown in IESDP; 16–31 are accepted as raw integers.

Example

Enable cures on an inn (Copper Coronet), then add a cure with AddStoreCure:

IF
  Global("iiCoronetCures","GLOBAL",1)
THEN
  RESPONSE #100
    SetGlobal("iiCoronetCures","GLOBAL",2)
    SetStoreFlag("BERNARD",CURES,TRUE)
    AddStoreCure("BERNARD","SPWI119",50)
END

Disable drink sales at an inn after an event:

IF
  Global("iiNoDrinks","GLOBAL",1)
THEN
  RESPONSE #100
    SetGlobal("iiNoDrinks","GLOBAL",2)
    SetStoreFlag("INN2616",DRINKS,FALSE)
END

Requirements

  • EEex + InfinityLoader
  • BGEE / BG2EE 2.6.6.0 Win64
  • Action ID 481

Behaviour notes

  • Loads the store via CStore, toggles m_header.m_nStoreFlags, calls CStore::Marshal (persists into temp for SAV packing), then CStore::InvalidateStore.
  • Also updates any already-loaded live copies (CInfGame.m_aServerStore / open CScreenStore store or bag) so the UI reflects the change without a restart.
  • When the store screen is open, rebuilds the bottom-button panel IDs from the new flags and refreshes the identify item list when bit 2 changes.
  • Missing / unloadable store resref: action errors.
  • Adding cure entries, room availability, drink lists, etc. is handled by other actions (AddStoreCure, SetStoreRooms, …). This action only toggles flag bits and UI buttons.

Flag-driven store buttons

Vanilla CScreenStore::StartStore wires bottom buttons by store type (inns never get Identify or Cures, temples always get Cures, and so on). That blocks scripted flag changes from surfacing on the “wrong” type.

This component hooks the end of StartStore’s button setup (pure ASM — no Lua call inside StartStore) and rebuilds the four bottom-button panel IDs from the STO flags on any store type:

Service Panel Shown when
Rooms 7 Store type is Inn (room enablement is SetStoreRooms / STO room data)
Buy / Sell 2 BUY or SELL
Identify 4 IDENTIFY
Donate 9 DONATE
Cures 5 CURES
Drinks 8 DRINKS

STEAL and other flags that are not bottom-bar services are still toggled in the STO header but do not add a strip button.

The engine only has four bottom-button slots. Candidates are offered in the order above. If more than four would appear:

  1. Drinks is dropped first
  2. Cures is dropped next if still over the cap
  3. Any further overflow is dropped from the end of the remaining list