Interface IXR_level

Source

namespace level

Hierarchy

IXR_level

Index

Methods

add_call add_cam_effector add_cam_effector2 add_complex_effector add_dialog_to_render add_pp_effector change_game_time check_object client_spawn_manager debug_actor debug_object disable_input enable_input environment game_id get_active_cam get_bounding_volume get_game_difficulty get_snd_volume get_target_dist get_target_element get_target_obj get_time_days get_time_factor get_time_hours get_time_minutes get_weather get_wfx_time hide_indicators hide_indicators_safe high_cover_in_direction is_wfx_playing iterate_online_objects iterate_sounds low_cover_in_direction main_input_receiver map_add_object_spot map_add_object_spot_ser map_change_spot_hint map_has_object_spot map_remove_object_spot name object_by_id patrol_path_exists physics_world prefetch_sound present rain_factor ray_pick remove_call remove_calls_for_object remove_cam_effector remove_complex_effector remove_dialog_to_render remove_pp_effector send set_active_cam set_game_difficulty set_pp_effector_factor set_snd_volume set_time_factor set_weather set_weather_fx show_indicators show_weapon spawn_item spawn_phantom start_stop_menu start_weather_fx_from_time stop_weather_fx vertex_id vertex_in_direction vertex_position

Methods

add_call

add_call(this, cb1, cb2): void
Parameters
- this: void
- cb1: ((this) => boolean)
  - - (this): boolean
    - Parameters
      
      this: void
      
      Returns boolean
- cb2: ((this) => boolean)
  - - (this): boolean
    - Parameters
      
      this: void
      
      Returns boolean
Returns void
- Defined in xr_lib/xr_level.d.ts:7
add_call(this, object, cb1, cb2): void
Parameters
- this: void
- object: object
- cb1: ((this) => boolean)
  - - (this): boolean
    - Parameters
      
      this: void
      
      Returns boolean
- cb2: ((this) => boolean)
  - - (this): boolean
    - Parameters
      
      this: void
      
      Returns boolean
Returns void
- Defined in xr_lib/xr_level.d.ts:9
add_call(this, object, str1, str2): void
Parameters
- this: void
- object: object
- str1: string
- str2: string
Returns void
- Defined in xr_lib/xr_level.d.ts:11

add_cam_effector

add_cam_effector(this, effect, id, is_cyclic, callback): void
Parameters
- this: void
- effect: string
- id: number
- is_cyclic: boolean
- callback: string
Returns void
- Defined in xr_lib/xr_level.d.ts:13

add_cam_effector2

add_cam_effector2(this, effect, id, is_cyclic, callback, camera_fov): void
Parameters
- this: void
- effect: string
- id: number
- is_cyclic: boolean
- callback: string
- camera_fov: number
Returns void
- Defined in xr_lib/xr_level.d.ts:15

add_complex_effector

add_complex_effector(this, section, id): void
Parameters
- this: void
- section: string
- id: number
Returns void
- Defined in xr_lib/xr_level.d.ts:17

add_dialog_to_render

add_dialog_to_render(this, window): void
Parameters
- this: void
- window: CUIDialogWnd
Returns void
- Defined in xr_lib/xr_level.d.ts:19

add_pp_effector

add_pp_effector(this, fn, id, is_cyclic): void
Parameters
- this: void
- fn: string
- id: number
- is_cyclic: boolean
Returns void
- Defined in xr_lib/xr_level.d.ts:21

change_game_time

change_game_time(this, days, hours, minutes): void
Move time forward based on provided parameters.
Parameters
- this: void
- days: number
  
  days to move forward
- hours: number
  
  hours to move forward
- minutes: number
  
  minutes to move forward
Returns void
- Defined in xr_lib/xr_level.d.ts:30

check_object

check_object(this, object): void
Parameters
- this: void
- object: game_object
Returns void
- Defined in xr_lib/xr_level.d.ts:32

client_spawn_manager

client_spawn_manager(this): client_spawn_manager
Parameters
- this: void
Returns client_spawn_manager
- Defined in xr_lib/xr_level.d.ts:34

debug_actor

debug_actor(this): game_object
Parameters
- this: void
Returns game_object
- Defined in xr_lib/xr_level.d.ts:36

debug_object

debug_object(this, str): game_object
Parameters
- this: void
- str: string
Returns game_object
- Defined in xr_lib/xr_level.d.ts:38

disable_input

disable_input(this): void
Parameters
- this: void
Returns void
- Defined in xr_lib/xr_level.d.ts:40

enable_input

enable_input(this): void
Parameters
- this: void
Returns void
- Defined in xr_lib/xr_level.d.ts:42

environment

environment(this): unknown
Parameters
- this: void
Returns unknown
- Defined in xr_lib/xr_level.d.ts:44

game_id

game_id(this): TXR_EGameID
Parameters
- this: void
Returns TXR_EGameID
current game state ID.
- Defined in xr_lib/xr_level.d.ts:49

get_active_cam

get_active_cam(this): number
Parameters
- this: void
Returns number
- Defined in xr_lib/xr_level.d.ts:51

get_bounding_volume

get_bounding_volume(this): Fbox
Parameters
- this: void
Returns Fbox
- Defined in xr_lib/xr_level.d.ts:53

get_game_difficulty

get_game_difficulty(this): TXR_game_difficulty
Parameters
- this: void
Returns TXR_game_difficulty
- Defined in xr_lib/xr_level.d.ts:55

get_snd_volume

get_snd_volume(this): number
Parameters
- this: void
Returns number
- Defined in xr_lib/xr_level.d.ts:57

get_target_dist

get_target_dist(this): number
Get object target distance aimed by crosshair.
Parameters
- this: void
Returns number
- Defined in xr_lib/xr_level.d.ts:62

get_target_element

get_target_element(this): number
Parameters
- this: void
Returns number
- Defined in xr_lib/xr_level.d.ts:64

get_target_obj

get_target_obj(this): game_object
Get object target aimed by crosshair.
Parameters
- this: void
Returns game_object
- Defined in xr_lib/xr_level.d.ts:69

get_time_days

get_time_days(this): number
Parameters
- this: void
Returns number
- Defined in xr_lib/xr_level.d.ts:71

get_time_factor

get_time_factor(this): number
Parameters
- this: void
Returns number
- Defined in xr_lib/xr_level.d.ts:73

get_time_hours

get_time_hours(this): number
Parameters
- this: void
Returns number
current hours time number
- Defined in xr_lib/xr_level.d.ts:78

get_time_minutes

get_time_minutes(this): number
Parameters
- this: void
Returns number
current minutes time number
- Defined in xr_lib/xr_level.d.ts:83

get_weather

get_weather(this): string
Parameters
- this: void
Returns string
- Defined in xr_lib/xr_level.d.ts:85

get_wfx_time

get_wfx_time(this): number
Parameters
- this: void
Returns number
- Defined in xr_lib/xr_level.d.ts:87

hide_indicators

hide_indicators(this): void
Parameters
- this: void
Returns void
- Defined in xr_lib/xr_level.d.ts:89

hide_indicators_safe

hide_indicators_safe(this): void
Parameters
- this: void
Returns void
- Defined in xr_lib/xr_level.d.ts:91

high_cover_in_direction

high_cover_in_direction(this, num, vector): number
Parameters
- this: void
- num: number
- vector: vector
Returns number
- Defined in xr_lib/xr_level.d.ts:93

is_wfx_playing

is_wfx_playing(this): boolean
Parameters
- this: void
Returns boolean
- Defined in xr_lib/xr_level.d.ts:95

iterate_online_objects

iterate_online_objects(this, cb): void
Parameters
- this: void
- cb: ((this, object) => boolean | void)
  - - (this, object): boolean | void
    - Parameters
      
      this: void
      
      object: game_object
      
      Returns boolean | void
Returns void
- Defined in xr_lib/xr_level.d.ts:97

iterate_sounds

iterate_sounds(this, str, num, cb): void
Parameters
- this: void
- str: string
- num: number
- cb: ((this) => void)
  - - (this): void
    - Parameters
      
      this: void
      
      Returns void
Returns void
- Defined in xr_lib/xr_level.d.ts:99
iterate_sounds(this, str, num, object, cb): void
Parameters
- this: void
- str: string
- num: number
- object: object
- cb: ((this) => void)
  - - (this): void
    - Parameters
      
      this: void
      
      Returns void
Returns void
- Defined in xr_lib/xr_level.d.ts:101

low_cover_in_direction

low_cover_in_direction(this, num, vector): number
Parameters
- this: void
- num: number
- vector: vector
Returns number
- Defined in xr_lib/xr_level.d.ts:103

main_input_receiver

main_input_receiver(this): CUIDialogWnd
Parameters
- this: void
Returns CUIDialogWnd
- Defined in xr_lib/xr_level.d.ts:105

map_add_object_spot

map_add_object_spot(this, id, selector, hint): void
Parameters
- this: void
- id: number
- selector: string
- hint: string
Returns void
- Defined in xr_lib/xr_level.d.ts:107

map_add_object_spot_ser

map_add_object_spot_ser(this, id, str1, str2): void
Parameters
- this: void
- id: number
- str1: string
- str2: string
Returns void
- Defined in xr_lib/xr_level.d.ts:109

map_change_spot_hint

map_change_spot_hint(this, num, selector, hint): void
Parameters
- this: void
- num: number
- selector: string
- hint: string
Returns void
- Defined in xr_lib/xr_level.d.ts:111

map_has_object_spot

map_has_object_spot(this, object_id, spot_type): number
Checks if object has map spot registered with provided selector.
Parameters
- this: void
- object_id: number
  
  game object id to check map spot
- spot_type: string
  
  map spot type (icon type to display for the object)
Returns number
whether object map spot with provided selector is registered
- Defined in xr_lib/xr_level.d.ts:120

map_remove_object_spot

map_remove_object_spot(this, object_id, spot_type): void
Remove object map spot if it exists. Checks if map spot is registered and then removes it in such case. There is no sense in checking object spot before calling removal since action will be duplicated.
Parameters
- this: void
- object_id: number
  
  game object id to check map spot
- spot_type: string
  
  map spot type (icon type to display for the object)
Returns void
- Defined in xr_lib/xr_level.d.ts:130

name

name<T>(this): T
Type Parameters
- T extends string = string
Parameters
- this: void
Returns T
- Defined in xr_lib/xr_level.d.ts:132

object_by_id

object_by_id(this, object_id): game_object
Parameters
- this: void
- object_id: number
Returns game_object
- Defined in xr_lib/xr_level.d.ts:134

patrol_path_exists

patrol_path_exists(this, path_name): boolean
Parameters
- this: void
- path_name: string
Returns boolean
- Defined in xr_lib/xr_level.d.ts:136

physics_world

physics_world(this): physics_world
Parameters
- this: void
Returns physics_world
- Defined in xr_lib/xr_level.d.ts:138

prefetch_sound

prefetch_sound(this, str): void
Parameters
- this: void
- str: string
Returns void
- Defined in xr_lib/xr_level.d.ts:140

present

present(this): boolean
Parameters
- this: void
Returns boolean
whether game level is loaded
- Defined in xr_lib/xr_level.d.ts:145

rain_factor

rain_factor(this): number
Parameters
- this: void
Returns number
intensity of rain, 0 if no rain active
- Defined in xr_lib/xr_level.d.ts:150

ray_pick

ray_pick(this, vec, vec2, fl, enumc, rqres, gobj): boolean
Parameters
- this: void
- vec: vector
- vec2: vector
- fl: number
- enumc: unknown
- rqres: unknown
- gobj: game_object
Returns boolean
- Defined in xr_lib/xr_level.d.ts:210

remove_call

remove_call(this, cb1, cb2): void
Parameters
- this: void
- cb1: ((this) => boolean)
  - - (this): boolean
    - Parameters
      
      this: void
      
      Returns boolean
- cb2: ((this) => void)
  - - (this): void
    - Parameters
      
      this: void
      
      Returns void
Returns void
- Defined in xr_lib/xr_level.d.ts:152
remove_call(this, object, cb1, cb2): void
Parameters
- this: void
- object: object
- cb1: ((this) => boolean)
  - - (this): boolean
    - Parameters
      
      this: void
      
      Returns boolean
- cb2: ((this) => void)
  - - (this): void
    - Parameters
      
      this: void
      
      Returns void
Returns void
- Defined in xr_lib/xr_level.d.ts:154
remove_call(this, object, str1, str2): void
Parameters
- this: void
- object: object
- str1: string
- str2: string
Returns void
- Defined in xr_lib/xr_level.d.ts:156

remove_calls_for_object

remove_calls_for_object(this, object): void
Parameters
- this: void
- object: object
Returns void
- Defined in xr_lib/xr_level.d.ts:158

remove_cam_effector

remove_cam_effector(this, id): void
Parameters
- this: void
- id: number
Returns void
- Defined in xr_lib/xr_level.d.ts:160

remove_complex_effector

remove_complex_effector(this, id): void
Parameters
- this: void
- id: number
Returns void
- Defined in xr_lib/xr_level.d.ts:162

remove_dialog_to_render

remove_dialog_to_render(this, window): void
Parameters
- this: void
- window: CUIDialogWnd
Returns void
- Defined in xr_lib/xr_level.d.ts:164

remove_pp_effector

remove_pp_effector(this, id): void
Parameters
- this: void
- id: number
Returns void
- Defined in xr_lib/xr_level.d.ts:166

send

send(net_packet, bool1, bool2, bool3, bool4): void
Parameters
- net_packet: net_packet
- bool1: boolean
- bool2: boolean
- bool3: boolean
- bool4: boolean
Returns void
- Defined in xr_lib/xr_level.d.ts:168

set_active_cam

set_active_cam(this, id): void
Parameters
- this: void
- id: number
Returns void
- Defined in xr_lib/xr_level.d.ts:170

set_game_difficulty

set_game_difficulty(this, difficulty): void
Parameters
- this: void
- difficulty: unknown
Returns void
- Defined in xr_lib/xr_level.d.ts:172

set_pp_effector_factor

set_pp_effector_factor(this, id, f, f_sp?): void
Parameters
- this: void
- id: number
- f: number
- Optional f_sp: number
Returns void
- Defined in xr_lib/xr_level.d.ts:174

set_snd_volume

set_snd_volume(this, num): void
Parameters
- this: void
- num: number
Returns void
- Defined in xr_lib/xr_level.d.ts:176

set_time_factor

set_time_factor(this, factor): void
Parameters
- this: void
- factor: number
Returns void
- Defined in xr_lib/xr_level.d.ts:178

set_weather

set_weather(this, weather_name, is_forced): void
Change active game weather.
Parameters
- this: void
- weather_name: string
  
  name of weather config to apply (gamedata\configs\environment\weathers)
- is_forced: boolean
  
  whether weather change should be forced
Returns void
- Defined in xr_lib/xr_level.d.ts:186

set_weather_fx

set_weather_fx(this, weather_fs_name): boolean
Parameters
- this: void
- weather_fs_name: string
Returns boolean
- Defined in xr_lib/xr_level.d.ts:188

show_indicators

show_indicators(this): void
Parameters
- this: void
Returns void
- Defined in xr_lib/xr_level.d.ts:190

show_weapon

show_weapon(this, val): void
Parameters
- this: void
- val: boolean
Returns void
- Defined in xr_lib/xr_level.d.ts:192

spawn_item

spawn_item(this, str, vector, uint, ushort, bool): void
Parameters
- this: void
- str: string
- vector: vector
- uint: number
- ushort: number
- bool: boolean
Returns void
- Defined in xr_lib/xr_level.d.ts:194

spawn_phantom

spawn_phantom(this, vector): void
Parameters
- this: void
- vector: vector
Returns void
- Defined in xr_lib/xr_level.d.ts:196

start_stop_menu

start_stop_menu(this, dialog, bool): void
Parameters
- this: void
- dialog: CUIDialogWnd
- bool: boolean
Returns void
- Defined in xr_lib/xr_level.d.ts:198

start_weather_fx_from_time

start_weather_fx_from_time(this, str, num): boolean
Parameters
- this: void
- str: string
- num: number
Returns boolean
- Defined in xr_lib/xr_level.d.ts:200

stop_weather_fx

stop_weather_fx(this): void
Parameters
- this: void
Returns void
- Defined in xr_lib/xr_level.d.ts:202

vertex_id

vertex_id(this, vector): number
Parameters
- this: void
- vector: vector
Returns number
- Defined in xr_lib/xr_level.d.ts:204

vertex_in_direction

vertex_in_direction(this, num1, vector, num2): number
Parameters
- this: void
- num1: number
- vector: vector
- num2: number
Returns number
- Defined in xr_lib/xr_level.d.ts:206

vertex_position

vertex_position(this, id): vector
Parameters
- this: void
- id: number
Returns vector
- Defined in xr_lib/xr_level.d.ts:208

Interface IXR_level

Source

Hierarchy

Index

Methods

Methods

add_call

Parameters

this: void

cb1: ((this) => boolean)

Parameters

this: void

Returns boolean

cb2: ((this) => boolean)

Parameters

this: void

Returns boolean

Returns void

Parameters

this: void

object: object

cb1: ((this) => boolean)

Parameters

this: void

Returns boolean

cb2: ((this) => boolean)

Parameters

this: void

Returns boolean

Returns void

Parameters

this: void

object: object

str1: string

str2: string

Returns void

add_cam_effector

Parameters

this: void

effect: string

id: number

is_cyclic: boolean

callback: string

Returns void

add_cam_effector2

Parameters

this: void

effect: string

id: number

is_cyclic: boolean

callback: string

camera_fov: number

Returns void

add_complex_effector

Parameters

this: void

section: string

id: number

Returns void

add_dialog_to_render

Parameters

this: void

window: CUIDialogWnd

Returns void

add_pp_effector

Parameters

this: void

fn: string

id: number

is_cyclic: boolean

Returns void

change_game_time

Parameters

this: void

days: number

hours: number

minutes: number

Returns void

check_object

Parameters