Skip to content

xray16

xr_action

NameDescription
actGlobal monster action.
animAnimation action.
condCompletion condition for a composed entity action.
CPatrolPathOpaque native patrol path handle used by low-level movement action bindings.
CSightParamsSight target snapshot.
entity_actionComposite action passed to scripted entities.
lookLook action for setting where an object should watch.
MonsterSpaceMonster movement, animation, and sound constants.
moveMovement action for stalkers, monsters, and vehicles.
particleParticle playback action.
particle_paramsParticle action transform parameters.
patrolPatrol path parameters used by movement actions.
soundSound action for scripted AI behavior.
XR_objectObject interaction action.
TXR_animationAnimation action constants exposed by the anim class.
TXR_animation_key-
TXR_body_stateBody-state constants accepted by stalker movement actions.
TXR_cond-
TXR_detail_path_typeDetail-path constants accepted by stalker movement actions.
TXR_entity_action-
TXR_look-
TXR_mental_stateMental-state constants accepted by stalker animation and movement APIs.
TXR_monster_animation_actionMonster animation action constants accepted by the two-argument anim constructor.
TXR_monster_head_animationMonster head-animation constants accepted by trader sound actions.
TXR_MonsterBodyState-
TXR_MonsterBodyStateKey-
TXR_moveMovement action constants exposed by the move class.
TXR_movement_typeMovement-type constants accepted by stalker movement actions.
TXR_object_action-
TXR_patrol_route_typePatrol route behavior accepted by native patrol path managers.
TXR_patrol_start_typePatrol start mode accepted by native patrol path managers.
TXR_patrol_typePatrol start or route enum value.
TXR_SightType-
TXR_sound_key-
TXR_sound_type-

xr_alife

NameDescription
alife_simulatorAccess point for ALife simulation objects and registries.
CALifeHumanBrainALife human brain binding.
CALifeMonsterBrainOffline ALife brain for monster server objects.
CALifeMonsterDetailPathManagerALife monster detail-path manager binding.
CALifeMonsterMovementManagerALife monster movement manager binding.
CALifeMonsterPatrolPathManagerALife monster patrol-path manager binding.
CALifeSmartTerrainTaskALife smart-terrain task binding.
client_spawn_managerClient-side spawn manager binding.
clsidEngine class id constants.
object_factoryFactory for ALife server object bindings.
spawn_story_idsStory id constants used by spawned objects.
story_idsStory id constants used by scripts.
TXR_class_idNumeric engine class id values from clsid.
TXR_class_keyScript-visible class id constant names from clsid.
TXR_dynamic_restrictor_typeDynamic restriction-list type accepted by APIs that clear ALife in/out restriction arrays.
TXR_restrictor_typeRestriction-space category stored on space restrictors and used by ALife restriction events.
alifeGet the active ALife simulator.

xr_animation

ClassDescription
color_animatorEvaluate a color animation by time.
dualityPost-process double-vision offsets.
effectorScript-controlled post-process effector.
effector_paramsMutable post-process state passed to effectors.
noisePost-process noise settings.

xr_anomaly

ClassDescription
CAmebaZoneClient object binding for CAmebaZone anomaly objects.
CFractureClient object binding for CFracture anomaly objects.
CHairsZoneClient object binding for CHairsZone anomaly objects.
CMincerClient object binding for CMincer anomaly objects.
CMosquitoBaldClient object binding for CMosquitoBald anomaly objects.
CNoGravityZoneClient object binding for CNoGravityZone anomaly objects.
CRadioactiveZoneClient object binding for CRadioactiveZone anomaly objects.
CTorchClient object binding for torch items.
CTorridZoneClient object binding for CTorridZone anomaly objects.

xr_artefact

ClassDescription
CArtefactClient-side artefact object.
CBastArtefactClient object binding for CBastArtefact artefacts.
CBlackDropsClient object binding for CBlackDrops artefacts.
CBlackGraviArtefactClient object binding for CBlackGraviArtefact artefacts.
CDummyArtefactClient object binding for CDummyArtefact artefacts.
CElectricBallClient object binding for CElectricBall artefacts.
CFadedBallClient object binding for CFadedBall artefacts.
CGalantineArtefactClient object binding for CGalantineArtefact artefacts.
CGraviArtefactClient object binding for CGraviArtefact artefacts.
CMercuryBallClient object binding for CMercuryBall artefacts.
CRustyHairArtefactClient object binding for CRustyHairArtefact artefacts.
CThornArtefactClient object binding for CThornArtefact artefacts.
CZudaArtefactClient object binding for CZudaArtefact artefacts.

xr_bitwise

FunctionDescription
bit_andApply bitwise AND to two signed integers.
bit_notInvert all bits in a signed integer.
bit_orApply bitwise OR to two signed integers.
bit_xorApply bitwise XOR to two signed integers.

xr_client_object

NameDescription
CGameObjectBase client-side game object.
object_binderScript-side binder attached to a client game_object.
IXR_IRender_VisualRender visual handle for client objects.

xr_color

NameDescription
colorMutable RGB color with float components.
fcolorMutable RGBA color with float components.
GetARGBPack alpha, red, green, and blue channels into an engine color value.

xr_core

ClassDescription
DLL_PureBase engine object exposed for compatibility with script binders.

xr_creature

ClassDescription
CActorClient object binding for CActor.
CAI_BloodsuckerClient object binding for CAI_Bloodsucker.
CAI_BoarClient object binding for CAI_Boar.
CAI_DogClient object binding for CAI_Dog.
CAI_FleshClient object binding for CAI_Flesh.
CAI_PseudoDogClient object binding for CAI_PseudoDog.
CAI_StalkerClient object binding for CAI_Stalker.
CAI_TraderClient object binding for CAI_Trader.
CBurerClient object binding for CBurer.
CCatClient object binding for CCat.
CChimeraClient object binding for CChimera.
CControllerClient object binding for CController.
CCustomMonsterRuntime family wrapper for custom monsters returned by game_object.cast_Monster().
CEntityAliveRuntime family wrapper for alive entities returned by game_object.cast_EntityAlive().
CInventoryItemRuntime family wrapper for inventory items returned by game_object.cast_InventoryItem().
CInventoryOwnerRuntime family wrapper for inventory owners returned by game_object.cast_InventoryOwner().
CPoltergeistClient object binding for CPoltergeist.
CPseudoGigantClient object binding for CPseudoGigant.
CPsyDogClient object binding for CPsyDog.
CPsyDogPhantomClient object binding for CPsyDogPhantom.
CSnorkClient object binding for CSnork.
CTushkanoClient object binding for CTushkano.
CZombieClient object binding for CZombie.

xr_debug

NameDescription
CConsoleEngine console interface.
command_lineGet process command-line parameters.
error_logLog an error message and print the current script stack.
flushFlush pending script log output in debug builds.
flush1Flush pending engine log output.
get_consoleGet console object reference.
logLog a message through the script log channel.
log1Log a message directly to the engine log.
print_stackPrint the current script stack to the log.

xr_dialog

ClassDescription
CPhraseRuntime phrase in a phrase dialog.
CPhraseDialogPhrase dialog built or extended from scripts.
CPhraseScriptScript rules attached to a dialog phrase.

xr_enemy_evaluation

NameDescription
cef_storageEnemy evaluation storage binding.
ef_storageGet the global storage for engine evaluation functions.

xr_flags

ClassDescription
flags16Mutable 16-bit flag mask.
flags32Mutable 32-bit flag mask.
flags8Mutable 8-bit flag mask.

xr_fs

NameDescription
FileStatusResult of an OpenXRay FS.exist query that checks virtual and/or external files.
FSEngine filesystem facade.
fs_fileFile descriptor exposed by the filesystem.
FS_file_listFile list returned by the engine filesystem.
FS_file_list_exSortable file list returned by extended filesystem queries.
FS_itemFile item from an engine file list.
FS_PathRegistered filesystem path alias descriptor.
IWriterOpaque filesystem writer handle.
TXR_fs_typeOpenXRay filesystem scope accepted by FS.exist() overloads that return FileStatus.
getFSGet the global filesystem facade.
user_nameGet operating system active username.

xr_game

NameDescription
game_difficultySingle-player difficulty constants.
GAME_TYPEGame type constants used by menu and multiplayer scripts.
IXR_gameGlobal helpers exposed by the engine game namespace.
TXR_EGameIDBitmask values returned by level.game_id().
TXR_game_difficulty-
TXR_game_difficulty_name-
TXR_GAME_TYPELegacy game type constants exposed through the GAME_TYPE Lua class.
gameGlobal engine game namespace.
editorCheck whether the in-game editor is active.
is_enough_address_space_availableCheck whether the process has enough address space for the current game.
IsDynamicMusicCheck whether dynamic music setting is enabled. Dynamic music starts playing different kind of ambient sounds in actor combat.
IsGameTypeSingleCheck whether the active game mode is single-player.
IsImportantSaveWhether auto-save on important checkpoints option is turned on.
script_server_object_versionGet server object serialization version used by scripts.
set_start_game_vertex_idSet the actor start game graph vertex.
set_start_positionSet the actor start position used by level transition logic.
verify_if_thread_is_runningAsk the engine to verify that its watched thread is still running.

xr_global_declaration

NameDescription
objectNote: typescript workaround since global type object is reserved.
cast_plannerCast a base action to an action planner when it is implemented as a planner action.
prefetchLoad and compile a script before continuing execution.
renderer_allow_overrideCheck whether renderer setting can be changed at runtime.

xr_goap

ClassDescription
action_baseAbstract class for implementation of GOAP planner actions.
action_plannerScript action planner binding for GOAP evaluators and actions.
planner_actionGOAP action class implementing both action base and action planner. Captures execution as action and plans its internal logic with separate logics graph.
property_evaluatorClass implementation of world properties evaluators. Generic handler to calculate current state of bound world property id.
property_evaluator_constClass implementation of world properties evaluators. Static handler to return pre-defined value for specific world property id.
property_storageStorage of object evaluators cached state for handling of in-game logic. Container for actions.
stalker_idsGOAP property and action id constants for stalker AI.
world_propertyGeneric container object for GOAP world properties.
world_stateWorld state describing whole world state in action planning.

xr_graph

NameDescription
CGameGraphGame graph access binding.
GameGraph__CVertexGame graph vertex binding.
game_graphGet the global game graph used by AI navigation.

xr_hit

NameDescription
hitHit packet that can be sent to game objects.
TXR_hit_type-
TXR_hit_types-

xr_ini

NameDescription
ini_fileLTX/INI file reader and writer.
create_ini_fileCreate ini file instance based on provided string content.
game_iniGet the loaded game ini.
reload_system_iniReload and return the system ini.
system_iniGet the loaded system ini.

xr_item

ClassDescription
CAdvancedDetectorClient object binding for advanced artefact detectors.
CAntiradClient object binding for CAntirad inventory items.
CBottleItemClient object binding for CBottleItem inventory items.
CEliteDetectorClient object binding for elite artefact detectors.
CExplosiveItemClient object binding for explosive inventory items.
CF1Client object binding for CF1 grenade items.
CFoodItemClient object binding for CFoodItem inventory items.
CGrenadeLauncherClient object binding for CGrenadeLauncher inventory items.
CInventoryBoxClient object binding for CInventoryBox inventory items.
CMedkitClient object binding for CMedkit inventory items.
CPdaClient object binding for CPda inventory items.
CRGD5Client object binding for CRGD5 grenade items.
CScientificDetectorClient object binding for scientific artefact detectors.
CScopeClient object binding for CScope inventory items.
CSilencerClient object binding for CSilencer inventory items.
CSimpleDetectorClient object binding for simple artefact detectors.
CStalkerOutfitClient object binding for CStalkerOutfit inventory items.
CWeaponClient object binding for CWeapon inventory items.
CWeaponAK74Client object binding for CWeaponAK74 inventory items.
CWeaponAmmoClient object binding for CWeaponAmmo inventory items.
CWeaponAutomaticShotgunClient object binding for CWeaponAutomaticShotgun inventory items.
CWeaponBinocularsClient object binding for CWeaponBinoculars inventory items.
CWeaponBM16Client object binding for CWeaponBM16 inventory items.
CWeaponFN2000Client object binding for CWeaponFN2000 inventory items.
CWeaponFORTClient object binding for CWeaponFORT inventory items.
CWeaponGrozaClient object binding for CWeaponGroza inventory items.
CWeaponHPSAClient object binding for CWeaponHPSA inventory items.
CWeaponKnifeClient object binding for CWeaponKnife inventory items.
CWeaponLR300Client object binding for CWeaponLR300 inventory items.
CWeaponMagazinedClient object binding for magazine-fed weapons.
CWeaponMagazinedWGrenadeClient object binding for magazine-fed weapons with grenade-launcher support.
CWeaponPMClient object binding for CWeaponPM inventory items.
CWeaponRG6Client object binding for CWeaponRG6 inventory items.
CWeaponRPG7Client object binding for CWeaponRPG7 inventory items.
CWeaponShotgunClient object binding for CWeaponShotgun inventory items.
CWeaponSVDClient object binding for CWeaponSVD inventory items.
CWeaponSVUClient object binding for CWeaponSVU inventory items.
CWeaponUSP45Client object binding for CWeaponUSP45 inventory items.
CWeaponValClient object binding for CWeaponVal inventory items.
CWeaponVintorezClient object binding for CWeaponVintorez inventory items.
CWeaponWaltherClient object binding for CWeaponWalther inventory items.
explosiveExplosive component shared by grenade and explosive item classes.

xr_level

NameDescription
CCarDriveable car and mounted weapon holder.
CDestroyablePhysicsObjectDestroyable animated physics object.
CEnvDescriptorActive weather descriptor exposed through CEnvironment.current().
CEnvironmentActive weather environment controller.
CHelicopterScript-controlled helicopter object.
CPhysicObjectAnimated client physics object.
CZoneCampfireCampfire anomaly object.
hanging_lampHanging lamp object controlled from scripts.
ray_pickReusable ray query object.
rq_resultResult object filled by level ray queries.
rq_targetRay query target bitmask accepted by level.ray_pick and ray_pick.
IXR_levelGlobal helpers for the currently loaded level.
TXR_CCar_weapon_paramMounted-weapon action and parameter ids exported on CCar.
TXR_helicopter_body_stateHelicopter body-state values returned by CHelicopter.GetBodyState().
TXR_helicopter_hunt_stateHelicopter enemy-tracking values returned by CHelicopter.GetHuntState().
TXR_helicopter_movement_stateHelicopter movement-state values returned by CHelicopter.GetMovementState().
TXR_helicopter_stateHelicopter life-state values returned by CHelicopter.GetState().
TXR_rq_targetRay query target bitmask accepted by level.ray_pick() and ray_pick.set_flags().
levelGlobal engine level namespace.

xr_luabind

NameDescription
class_info_dataRuntime metadata for a LuaBind class.
EngineBindingBase class for LuaBind-backed engine objects.
lua_StateOpaque native Lua state pointer.
TEngineBindingStaticMethodsStatic members owned by EngineBinding and excluded from exported engine enum values.
class_infoGet LuaBind metadata for an object or class.
class_namesGet names of LuaBind classes registered in a Lua state.
LuabindClassMark a TypeScript class for LuaBind class transformation.

xr_map

ClassDescription
CMapLocationA single PDA/minimap spot attached to an object or user position.
CMapManagerManages active PDA/minimap locations.

xr_math

ClassDescription
FboxAxis-aligned 3D box.
FquaternionOpaque native quaternion used by matrix transform helpers.
FrectRectangle with top-left and bottom-right points.
matrixMutable 4x4 transform matrix.
rotationHeading/pitch rotation pair.
RPointPatrol graph point with position and angle vectors.
vectorMutable 3D float vector.
vector2Mutable 2D float vector.

xr_memory

NameDescription
danger_objectAI danger event remembered by an object.
entity_memory_objectMemory record that points to a living entity.
game_memory_objectMemory record that points to a game object.
hit_memory_objectMemory record for a hit received by an entity.
memory_infoCombined visible, sound, and hit memory flags for one object.
memory_objectBase memory record with timing information.
not_yet_visible_objectVisual memory candidate that has not become fully visible yet.
object_paramsPosition and level-vertex snapshot for a remembered object.
sound_memory_objectMemory record for a heard object or sound event.
visible_memory_objectMemory record for a visible object.
TXR_danger_object-
TXR_danger_objects-
TXR_danger_perceive_typeHow a danger event was perceived by AI memory.

xr_multiplayer

NameDescription
account_managerGameSpy account operations used by multiplayer menus.
account_operation_cbMultiplayer callback binding for account_operation_cb.
account_profiles_cbMultiplayer callback binding for account_profiles_cb.
award_dataAward or best-score value with the last reward date.
award_pair_tMultiplayer data binding for award_pair_t.
best_scores_pair_tMultiplayer data binding for best_scores_pair_t.
connect_error_cbMultiplayer callback binding for connect_error_cb.
demo_infoMetadata stored inside a recorded multiplayer demo.
demo_player_infoPlayer stats saved inside a recorded multiplayer demo.
found_email_cbMultiplayer callback binding for found_email_cb.
game_GameStateCurrent multiplayer game state.
game_messagesMultiplayer game event ids sent through game state messaging.
game_player_item_listOpaque native list of multiplayer buy/spawn item ids.
game_PlayerStateMultiplayer player state replicated by multiplayer game modes.
login_managerMultiplayer login and saved credential operations.
login_operation_cbMultiplayer callback binding for login_operation_cb.
Patch_Dawnload_ProgressMultiplayer patch download progress.
profileGameSpy profile returned by login operations.
profile_storeGameSpy profile storage for awards and best scores.
SServerFiltersServer browser filters used by the multiplayer UI.
store_operation_cbMultiplayer callback binding for store_operation_cb.
suggest_nicks_cbMultiplayer callback binding for suggest_nicks_cb.
TXR_game_message-

xr_object_server

NameDescription
cse_abstractBase abstract logic for any representation of objects on server side.
CSE_AbstractVisualServer object binding for CSE_AbstractVisual.
cse_alife_carServer object binding for cse_alife_car.
cse_alife_creature_abstractBase representation of any alive creature on server side.
cse_alife_creature_actorServer object binding for cse_alife_creature_actor.
cse_alife_creature_crowServer object binding for cse_alife_creature_crow.
cse_alife_creature_phantomServer object binding for cse_alife_creature_phantom.
cse_alife_dynamic_objectServer-side ALife object that can switch between offline simulation and an online client object.
cse_alife_dynamic_object_visualServer object binding for cse_alife_dynamic_object_visual.
cse_alife_graph_pointServer object binding for cse_alife_graph_point.
cse_alife_helicopterServer object binding for cse_alife_helicopter.
cse_alife_human_abstractBase representation of any human stalker on server side.
cse_alife_human_stalkerServer object binding for cse_alife_human_stalker.
cse_alife_inventory_boxServer object binding for cse_alife_inventory_box.
cse_alife_itemBase representation of any item on server side.
cse_alife_item_ammoServer object binding for cse_alife_item_ammo.
cse_alife_item_artefactServer object binding for cse_alife_item_artefact.
cse_alife_item_boltServer object binding for cse_alife_item_bolt.
cse_alife_item_custom_outfitServer object binding for cse_alife_item_custom_outfit.
cse_alife_item_detectorServer object binding for cse_alife_item_detector.
cse_alife_item_documentServer object binding for cse_alife_item_document.
cse_alife_item_explosiveServer object binding for cse_alife_item_explosive.
cse_alife_item_grenadeServer object binding for cse_alife_item_grenade.
cse_alife_item_helmetServer object binding for cse_alife_item_helmet.
cse_alife_item_pdaServer object binding for cse_alife_item_pda.
cse_alife_item_torchServer object binding for cse_alife_item_torch.
cse_alife_item_weaponBase representation of any weapon item on server side.
cse_alife_item_weapon_auto_shotgunServer object binding for cse_alife_item_weapon_auto_shotgun.
cse_alife_item_weapon_magazinedServer object binding for cse_alife_item_weapon_magazined.
cse_alife_item_weapon_magazined_w_glBase class for magazined weapons with grenade launcher.
cse_alife_item_weapon_shotgunServer object binding for cse_alife_item_weapon_shotgun.
cse_alife_level_changerServer object binding for cse_alife_level_changer.
cse_alife_monster_abstractServer object binding for cse_alife_monster_abstract.
cse_alife_monster_baseServer object binding for cse_alife_monster_base.
cse_alife_monster_ratServer object binding for cse_alife_monster_rat.
cse_alife_monster_zombieServer object binding for cse_alife_monster_zombie.
cse_alife_mounted_weaponServer object binding for cse_alife_mounted_weapon.
cse_alife_objectBase representation of any object on server side.
cse_alife_object_climableServer object binding for cse_alife_object_climable.
cse_alife_object_hanging_lampServer object binding for cse_alife_object_hanging_lamp.
cse_alife_object_physicServer object binding for cse_alife_object_physic.
cse_alife_object_projectorServer object binding for cse_alife_object_projector.
cse_alife_online_offline_groupServer object binding for cse_alife_online_offline_group.
cse_alife_ph_skeleton_objectServer object binding for cse_alife_ph_skeleton_object.
cse_alife_psydog_phantomServer object binding for cse_alife_psydog_phantom.
cse_alife_smart_zoneServer object binding for cse_alife_smart_zone.
cse_alife_space_restrictorServer object binding for cse_alife_space_restrictor.
cse_alife_team_base_zoneServer object binding for cse_alife_team_base_zone.
cse_alife_traderServer object binding for cse_alife_trader.
cse_alife_trader_abstractServer object binding for cse_alife_trader_abstract.
cse_anomalous_zoneServer object binding for cse_anomalous_zone.
cse_custom_zoneServer object binding for cse_custom_zone.
cse_smart_coverServer object binding for cse_smart_cover.
cse_spectatorServer object binding for cse_spectator.
cse_temporaryServer object binding for cse_temporary.
cse_torrid_zoneServer object binding for cse_torrid_zone.
cse_zone_visualServer object binding for cse_zone_visual.
IXR_cpure_server_object-
IXR_cse_alife_group_abstract-
IXR_cse_alife_inventory_itemServer-side inventory item mixin.
IXR_cse_alife_object_breakable-
IXR_cse_alife_schedulable-
IXR_cse_motion-
IXR_cse_ph_skeleton-
IXR_cse_shape-
IXR_cse_visual-
IXR_ipure_alife_load_object-
IXR_ipure_alife_load_save_object-
IXR_ipure_alife_save_object-
IXR_ipure_schedulable_object-
IXR_ipure_server_object-
IXR_squad_memberSquad member representation.

xr_physic

ClassDescription
CPHActionOpaque native physics action handle.
CPHConditionOpaque native physics condition handle.
CPhysicsShellHolderClient object that owns a physics shell.
holderHolder object that the actor can engage with.
IKinematicsAnimatedAnimated model kinematics.
particles_objectScript-controlled particle system.
phaction_constforcePhysics action that applies a constant force to a shell when run.
phcondition_callonstepPhysics condition that becomes true on or after a selected physics step/time.
phcondition_expireonstepPhysics condition that expires on the selected step.
physics_elementOne rigid body element inside a physics shell.
physics_jointJoint connecting two physics elements.
physics_shellPhysics shell made of elements and joints.
physics_worldGlobal physics world controls.

xr_profiler

NameDescription
profile_timerLightweight script profile timer.
IXR_profilerLua script profiler namespace.
IXR_tracy-
TXR_ProfilerTypeLua profiler mode accepted by profiler.start().
profilerLua script profiler namespace.
PROFILER_TYPE_HOOKHook-based Lua profiler.
PROFILER_TYPE_NONENo Lua profiler is active.
PROFILER_TYPE_SAMPLINGLuaJIT sampling profiler.
tracyTracy profiling namespace.

xr_properties

NameDescription
bool_value-
button_value-
canvas_value-
caption_value-
choose_typeEditor asset chooser mode constants.
choose_value-
color_value-
flag16_value-
flag32_value-
flag8_value-
float_value-
list_value-
prop_item_vecNative editor property item collection.
prop_valueBase editor property value wrapper.
properties_helperGlobal editor properties helper.
properties_list_helperHelper for building editor property rows for spawned objects.
rtoken_listOrdered list of string tokens for runtime-selectable editor values.
s16_value-
s32_value-
s8_value-
TEX_INFOTexture atlas entry exposed by UI texture metadata.
text_value-
tokenNamed integer token used by editor property lists.
token_listName-to-id token list for editor dropdown values.
token16_value-
token32_value-
token8_value-
u16_value-
u32_value-
u8_value-
vector_value-
TXR_choose_typeEditor asset chooser mode value.

xr_relation

NameDescription
FactionStateFaction state shown by faction-war UI scripts.
IXR_relation_registry-
TXR_relationRelation type returned by game_object.relation() and accepted by game_object.set_relation().
TXR_relation_nameRelation type names exposed through the game_object.relation Lua enum.
relation_registryGlobal relation registry helpers.

xr_render

NameDescription
render_deviceCurrent render device state.
app_readyCheck whether the game persistent state finished loading.
deviceGet the global render device.
render_get_dx_levelGet active renderer feature level.
xrRender_test_r2_hwCheck whether R2 renderer hardware support is available.

xr_save

NameDescription
ClientIDNetwork client identifier.
CSavedGameWrapperLightweight view over save-game metadata.
net_packetRead/write network packet used by server entities and events.
readerBinary reader used for save data and chunk payloads.
TXR_net_processorAny engine binary input accepted by save/network serializers.
valid_saved_gameCheck whether a save exists and has a compatible header.

xr_script_interface

NameDescription
callbackEngine callback id registry.
cover_pointCover point returned by cover search helpers.
game_object_callbacks_implementation_basegame_object.set_callback overloads for Lua-visible game object callbacks.
MonsterHitInfoHit context passed to monster combat callbacks.
TXR_action_typeScript entity action type id passed to action callbacks.
TXR_bloodsucker_visibility_stateVisibility state of bloodsucker. Possible values are: - unset = -1, - no_visibility = 0, - partial_visibility = 1, - full_visibility = 2.
TXR_callback-
TXR_callbacks-
TXR_game_object_pathMovement path type accepted by game_object.set_path_type() and returned by game_object.path_type().
TXR_movement_selection_typeGame-graph destination selection mode for stalker movement.

xr_script_object

ClassDescription
game_objectClient object base presentation as script object. Generic in-game entities from items to mutants and stalkers wrapped with luabind export.

xr_script_trade

FunctionDescription
buy_conditionSet default buy trade factors.
sell_conditionSet default sell trade factors.
show_conditionLoad default item visibility trade condition from config.

xr_sound

NameDescription
snd_typeSound category constants used by AI sound memory and sound playback.
sound_objectPlay an engine sound resource from scripts.
sound_paramsCurrent playback parameters for a launched sound.
SoundInfoLast sound perceived by an object.
TXR_snd_typeAI sound category bitmask used by sound memory, callbacks, and sound actions.
TXR_sound_object_typePlayback mode flag accepted by sound_object.play() and play_at_pos().

xr_stats

NameDescription
IXR_actor_statsActor statistics helpers exposed through the actor_stats namespace.
actor_statsActor statistics namespace.

xr_task

NameDescription
CGameTaskGame task with one or more objectives.
SGameTaskObjectiveOne objective inside a game task.
taskTask state and task type constants.
TXR_TaskStateRuntime task state returned by task and objective state APIs.
TXR_TaskStateNameScript-visible task state constant names from the task.task_state enum.
TXR_TaskTypeTask category used by SGameTaskObjective.get_type() and set_type().
TXR_TaskTypeNameTask type constant names, including the shared native dummy sentinel.

xr_time

NameDescription
CTimeMutable game calendar/time value.
time_globalGet main-thread engine time in milliseconds since executable start.
time_global_asyncGet asynchronous engine time in milliseconds since executable start.

xr_type

Type AliasDescription
AnyObject-
EnumeratedStaticsKeys-
EnumeratedStaticsValues-
f32-
f64-
i16-
i32-
i64-
i8-
u16-
u32-
u64-
u8-

xr_ui_asset

NameDescription
CGameFontGame font binding used by UI widgets.
UIStyleManagerUI style manager binding.
TXR_CGameFont_alignmentEVTextAlignment.
GetDefaultUIPathGet the default UI path.
GetDefaultUIPathWithDelimiterGet the default UI path with trailing delimiter.
GetFontDIGet the small digital/interface font.
GetFontGraffiti19RussianGet the 19px Graffiti Russian UI font.
GetFontGraffiti22RussianGet the 22px Graffiti Russian UI font.
GetFontGraffiti32RussianGet the 32px Graffiti Russian UI font.
GetFontGraffiti50RussianGet the 50px Graffiti Russian UI font.
GetFontLetterica16RussianGet the 16px Letterica Russian UI font.
GetFontLetterica18RussianGet the 18px Letterica Russian UI font.
GetFontLetterica25Get the 25px Letterica UI font.
GetFontMediumGet the medium HUD font.
GetFontSmallGet the small HUD font.
GetTextureInfoGet texture metadata and throw if it is missing.
GetTextureNameGet source texture file name for an atlas entry.
GetUIPathGet the active UI path.
GetUIPathWithDelimiterGet the active UI path with trailing delimiter.
GetUIStyleManagerGet the global UI style manager.

xr_ui_core

NameDescription
CScriptXmlInitXML UI initialization helper.
FitInRectMove a window so it fits inside a rectangle.
GetCursorPositionGet current UI cursor position.
GetTextureRectGet the texture rectangle for a UI atlas entry.
SetCursorPositionSet current UI cursor position.

xr_ui_event

NameDescription
DIK_keysKeyboard scan-code constants.
key_bindingsGame action binding constants.
ui_eventsUI event id constants.
TXR_DIK_keyDIK, mouse, or gamepad key code passed to keyboard/input callbacks.
TXR_DIK_key_nameStatic key constant name from DIK_keys.
TXR_ui_eventUI event id passed to window message handlers such as CUIScriptWnd.OnKeyboard().
bind_to_dikGet the primary DIK key bound to a game action.
dik_to_bindTransforms dik key enumeration code to key binding code.

xr_ui_interface

NameDescription
CDialogHolderUI binding for CDialogHolder.
CServerListUI binding for CServerList.
CUI3tButtonUI binding for CUI3tButton.
CUIActorMenuUI binding for CUIActorMenu.
CUIButtonUI binding for CUIButton.
CUICheckButtonUI binding for CUICheckButton.
CUIComboBoxUI binding for CUIComboBox.
CUICustomEditUI binding for CUICustomEdit.
CUICustomSpinUI binding for CUICustomSpin.
CUIDialogWndUI binding for CUIDialogWnd.
CUIEditBoxUI binding for CUIEditBox.
CUIEditBoxExUI binding for CUIEditBoxEx.
CUIFrameLineWndUI binding for CUIFrameLineWnd.
CUIFrameWindowUI binding for CUIFrameWindow.
CUILinesUI binding for CUILines.
CUIListBoxUI binding for CUIListBox.
CUIListBoxItemUI binding for CUIListBoxItem.
CUIListBoxItemMsgChainUI binding for CUIListBoxItemMsgChain.
CUIListItemUI binding for CUIListItem.
CUIListItemExUI binding for CUIListItemEx.
CUIListWndUI binding for CUIListWnd.
CUIMapInfoUI binding for CUIMapInfo.
CUIMapListUI binding for CUIMapList.
CUIMessageBoxUI binding for CUIMessageBox.
CUIMessageBoxExUI binding for CUIMessageBoxEx.
CUIMMShniagaUI binding for CUIMMShniaga.
CUIPdaWndUI binding for CUIPdaWnd.
CUIProgressBarUI binding for CUIProgressBar.
CUIPropertiesBoxUI binding for CUIPropertiesBox.
CUIScriptWndUI binding for CUIScriptWnd.
CUIScrollViewUI binding for CUIScrollView.
CUISleepStaticUI binding for CUISleepStatic.
CUISpinFltUI binding for CUISpinFlt.
CUISpinNumUI binding for CUISpinNum.
CUISpinTextUI binding for CUISpinText.
CUIStaticUI binding for CUIStatic.
CUITabButtonUI binding for CUITabButton.
CUITabControlUI binding for CUITabControl.
CUITextWndUI binding for CUITextWnd.
CUITrackBarUI binding for CUITrackBar.
CUIVersionListUI binding for CUIVersionList.
CUIWindowBase UI window used by script-created controls.
EDDListTypeActor menu drag-and-drop list type constants.
StaticDrawableWrapperUI binding for StaticDrawableWrapper.
UIHintUI binding for UIHint.
TXR_EDDListType-
TXR_MMShniaga_page-

xr_ui_menu

NameDescription
CMainMenuMain menu binding.
COptionsManagerMain-menu options manager binding.
CUIGameCustomIn-game UI root binding.
IXR_ActorMenuActor/PDA menu namespace exposed to scripts.
IXR_main_menuMain menu namespace exposed to scripts.
ActorMenu-
main_menu-
get_hudGet the current game HUD UI.

xr_zone

ClassDescription
CCustomZoneRuntime family wrapper for custom anomaly zones returned by game_object.cast_CustomZone().
ce_script_zoneServer object binding for script zone spawn entities.
ce_smart_zoneServer object binding for smart-zone spawn entities.
CLevelChangerClient object binding for CLevelChanger zones.
CSpaceRestrictorClient object binding for CSpaceRestrictor zones.
smart_cover_objectClient object binding for smart_cover_object zones.