Skip to content

Library Checks

← CHK Functions · code catalog

Friendly names for CHK category 10. Each maps to a top-level CHK code.

CheckGetStringlistID

CheckGetStringlistID(library_Name: string, stringlist_ID: int)  ·  chk 159

Use when writing library events to get correct stringlist when library is used. This Check returns always the correct ID of the stringlist.

Parameters

  • library_Name (string) — Library Name
  • stringlist_ID (int) — Stringlist ID

Example: chk(159,'Name',1)

CheckLibVarGlobal

CheckLibVarGlobal(library_Name: string, variable_Name: string)  ·  chk 160

Returns the value of specified global libvar.

Parameters

  • library_Name (string) — Library Name
  • variable_Name (string) — Variable Name

Example: chk(160,'Name','Name')

CheckGetEventPic

CheckGetEventPic(library_Name: string, orig_eventPic_SlotNr: int)  ·  chk 161

Returns the current eventPic Nr. If you are writing library events that use eventpics you should always call this check first.

Parameters

  • library_Name (string) — Library Name
  • orig_eventPic_SlotNr (int) — Orig eventPic SlotNr

Example: chk(161,'Name',1)

CheckGetSmallPic

CheckGetSmallPic(library_Name: string, orig_smallPic_SlotNr: int)  ·  chk 162

Returns the current smallPic Nr. If you are writing library events that use small pics you should always call this check first.

Parameters

  • library_Name (string) — Library Name
  • orig_smallPic_SlotNr (int) — Orig smallPic SlotNr

Example: chk(162,'Name',1)

CheckGetHistoricalIDByLib

CheckGetHistoricalIDByLib(library_Name: string, iD: int)  ·  chk 165

Returns the ID of the historical unit/historical model in the current scenario.

Parameters

  • library_Name (string) — Library Name
  • iD (int) — ID

Example: chk(165,'Name',1)

CheckGetHistoricalIDForCommanderByLib

CheckGetHistoricalIDForCommanderByLib(library_Name: string, iD: int)  ·  chk 166

Returns the ID of the commander in the current scenario.

Parameters

  • library_Name (string) — Library Name
  • iD (int) — ID

Example: chk(166,'Name',1)

CheckGetPeopleByLib

CheckGetPeopleByLib(library_Name: string, iD: int)  ·  chk 167

Returns the slot of the people in the current scenario.

Parameters

  • library_Name (string) — Library Name
  • iD (int) — ID

Example: chk(167,'Name',1)

CheckGetRegimeByLib

CheckGetRegimeByLib(library_Name: string, iD: int)  ·  chk 168

Returns the slot of the regime in the current scenario.

Parameters

  • library_Name (string) — Library Name
  • iD (int) — ID

Example: chk(168,'Name',1)

CheckGetSFTypeByLib

CheckGetSFTypeByLib(library_Name: string, iD: int)  ·  chk 169

Returns the slot of the SFType in the current scenario.

Parameters

  • library_Name (string) — Library Name
  • iD (int) — ID

Example: chk(169,'Name',1)

CheckGetEventByLib

CheckGetEventByLib(library_Name: string, iD: int)  ·  chk 170

Returns the slot of the event in the current scenario.

Parameters

  • library_Name (string) — Library Name
  • iD (int) — ID

Example: chk(170,'Name',1)

CheckGetCardByLib

CheckGetCardByLib(library_Name: string, library_Slot: int)  ·  chk 171

Returns the slot of the actioncard in the current scenario.

Parameters

  • library_Name (string) — Library Name
  • library_Slot (int) — Library Slot

Example: chk(171,'Name',1)

CheckLibVarHistorical

CheckLibVarHistorical(historical_Unit_Slot_in_this_scenario: int, library_Name: string, libVar_Name: string)  ·  chk 172

Returns the value of specified Libvar for historical unit or historical model.

Parameters

  • historical_Unit_Slot_in_this_scenario (int) — Historical Unit Slot (in this scenario)
  • library_Name (string) — Library Name
  • libVar_Name (string) — LibVar Name

Example: chk(172,1,'Name','Name')

CheckLibVarLandscape

CheckLibVarLandscape(landscape_Slot_in_this_scenario: int, library_Name: string, libVar_Name: string)  ·  chk 173

Returns the value of specified Libvar.

Parameters

  • landscape_Slot_in_this_scenario (int) — Landscape Slot (in this scenario)
  • library_Name (string) — Library Name
  • libVar_Name (string) — LibVar Name

Example: chk(173,1,'Name','Name')

CheckLibVarPeople

CheckLibVarPeople(people_Slot_in_this_scenario: int, library_Name: string, libVar_Name: string)  ·  chk 174

Returns the value of specified Libvar.

Parameters

  • people_Slot_in_this_scenario (int) — People Slot (in this scenario)
  • library_Name (string) — Library Name
  • libVar_Name (string) — LibVar Name

Example: chk(174,2,'Name','Name')

CheckLibVarRegime

CheckLibVarRegime(regime_Slot_in_this_scenario: int, library_Name: string, libVar_Name: string)  ·  chk 175

Returns the value of specified Libvar.

Parameters

  • regime_Slot_in_this_scenario (int) — Regime Slot (in this scenario)
  • library_Name (string) — Library Name
  • libVar_Name (string) — LibVar Name

Example: chk(175,4,'Name','Name')

CheckLibVarRiver

CheckLibVarRiver(river_Slot_in_this_scenario: int, library_Name: string, libVar_Name: string)  ·  chk 176

Returns the value of specified Libvar.

Parameters

  • river_Slot_in_this_scenario (int) — River Slot (in this scenario)
  • library_Name (string) — Library Name
  • libVar_Name (string) — LibVar Name

Example: chk(176,1,'Name','Name')

CheckLibVarRoad

CheckLibVarRoad(road_Slot_in_this_scenario: int, library_Name: string, libVar_Name: string)  ·  chk 177

Returns the value of specified Libvar.

Parameters

  • road_Slot_in_this_scenario (int) — Road Slot (in this scenario)
  • library_Name (string) — Library Name
  • libVar_Name (string) — LibVar Name

Example: chk(177,1,'Name','Name')

CheckLibVarSFType

CheckLibVarSFType(sFType_Slot_in_this_scenario: int, library_Name: string, libVar_Name: string)  ·  chk 178

Returns the value of specified Libvar.

Parameters

  • sFType_Slot_in_this_scenario (int) — SFType Slot (in this scenario)
  • library_Name (string) — Library Name
  • libVar_Name (string) — LibVar Name

Example: chk(178,1,'Name','Name')

CheckLibVarLocType

CheckLibVarLocType(locType_Slot_in_this_scenario: int, library_Name: string, libVar_Name: string)  ·  chk 179

Returns the value of specified Libvar.

Parameters

  • locType_Slot_in_this_scenario (int) — LocType Slot (in this scenario)
  • library_Name (string) — Library Name
  • libVar_Name (string) — LibVar Name

Example: chk(179,1,'Name','Name')

CheckLibVarHex

CheckLibVarHex(x: int, y: int, library_Name: string, libVar_Name: string)  ·  chk 180

Returns the value of specified libvar of that hex. No value set returns 0.

Parameters

  • x (int) — X
  • y (int) — Y
  • library_Name (string) — Library Name
  • libVar_Name (string) — LibVar Name

Example: chk(180,12,8,'Name','Name')

CheckLibVarCommander

CheckLibVarCommander(commanders_Historical_Unit_Slot: int, library_Name: string, libVar_Name: string)  ·  chk 181

Returns the value of specified Libvar for historical commander.

Parameters

  • commanders_Historical_Unit_Slot (int) — Commanders Historical Unit Slot
  • library_Name (string) — Library Name
  • libVar_Name (string) — LibVar Name

Example: chk(181,1,'Name','Name')

CheckGetPreDefIDByLib

CheckGetPreDefIDByLib(library_Name: string, preDefID: int)  ·  chk 188

Returns the preDefID in the current scenario for a the PreDefID inside a specific library.

Parameters

  • library_Name (string) — Library Name
  • preDefID (int) — PreDefID

Example: chk(188,'Name',200)

CheckLibraryOfCard

CheckLibraryOfCard(action_Card_Slot: int)  ·  chk 198

Returns a string with the library name.

Parameters

  • action_Card_Slot (int) — Action Card Slot

Example: chk(198,1)

CheckGetReinfTypeByLib

CheckGetReinfTypeByLib(library_Name: string, iD: int)  ·  chk 250

Returns the ID of the Reinf.Type in the current scenario.

Parameters

  • library_Name (string) — Library Name
  • iD (int) — ID

Example: chk(250,'Name',1)

CheckLibraryOfSFType

CheckLibraryOfSFType(sFType_Slot: int)  ·  chk 260

Returns a string with the library name.

Parameters

  • sFType_Slot (int) — SFType Slot

Example: chk(260,1)

CheckDLC

CheckDLC(dLC_ID_Code: int)  ·  chk 261

Not documented. Usage by other than Vic is not advised.

Parameters

  • dLC_ID_Code (int) — DLC ID Code

Example: chk(261,1)

CheckLibraryOfThisEvent

CheckLibraryOfThisEvent(arg: int)  ·  chk 262

Returns a string with the library name.

Parameters

  • arg (int) —

Example: chk(262,1)

CheckSubVersion

CheckSubVersion()  ·  chk 265

Returns SubVersion (product6: 1=dc5 for example) if exists and 0/-1 if not

Example: chk(265)

This doc was generated from extracting data from Shadow Empire version 1.32a on 2026-06-05 06:56 UTC.