xray16 1.0.0

package/src/xr_object/xr_action.d.ts

@@ -0,0 +1,482 @@
+declare module "xray16" {
+  /**
+   * @source C++ class world_state
+   * @customConstructor world_state
+   * @group xr_action
+   */
+  export class world_state extends EngineBinding {
+    public constructor();
+    public constructor(world_state: world_state);
+
+    public add_property(world_property: world_property): void;
+    public clear(): void;
+    public includes(world_state: world_state): boolean;
+    public property(value: u32): world_property;
+    public remove_property(value: u32): void;
+  }
+
+  /**
+   * @source C++ class entity_action
+   * @customConstructor entity_action
+   * @group xr_action
+   */
+  export class entity_action extends EngineBinding {
+    public constructor();
+    public constructor(entity: entity_action);
+
+    public set_action(move: move): void;
+    public set_action(look: look): void;
+    public set_action(anim: anim): void;
+    public set_action(sound: sound): void;
+    public set_action(particle: particle): void;
+    public set_action(objec: XR_object): void;
+    public set_action(cond: cond): void;
+
+    public move(): boolean;
+    public particle(): boolean;
+    public completed(): boolean;
+    public object(): boolean;
+    public all(): boolean;
+    public time(): boolean;
+    public look(): boolean;
+    public sound(): boolean;
+    public anim(): boolean;
+  }
+
+  /**
+   * @group xr_action
+   */
+  export type TXR_entity_action = move | look | anim | sound | particle | XR_object | cond;
+
+  /**
+   * @source C++ class move
+   * @customConstructor move
+   * @group xr_action
+   */
+  export class move extends EngineBinding {
+    // todo: All enums are in one static, probably should declare few parent interfaces / classes with enums
+    public static readonly crouch: 0;
+
+    public static readonly back: 4;
+    public static readonly criteria: 2;
+
+    public static readonly curve: 0;
+    public static readonly curve_criteria: 2;
+
+    public static readonly default: 0;
+    public static readonly dodge: 1;
+    public static readonly down: 64;
+    public static readonly drag: 3;
+    public static readonly force: 1;
+    public static readonly fwd: 2;
+    public static readonly handbrake: 128;
+    public static readonly jump: 4;
+    public static readonly left: 8;
+
+    public static readonly line: 0;
+    public static readonly none: 1;
+    public static readonly off: 512;
+    public static readonly on: 256;
+    public static readonly right: 16;
+
+    /**
+     * Fast run movement type, not sprint but generic fast movement.
+     */
+    public static readonly run: 1;
+    public static readonly run_fwd: 2;
+    public static readonly run_with_leader: 7;
+    public static readonly stand: 2;
+    public static readonly standing: 1;
+    public static readonly steal: 5;
+    public static readonly up: 32;
+    /**
+     * Normal walk movement type, generic movement type used in most cases.
+     */
+    public static readonly walk: 0;
+
+    public static readonly walk_fwd: 0;
+    public static readonly walk_bkwd: 1;
+    public static readonly walk_with_leader: 6;
+
+    public constructor();
+    public constructor(action: unknown);
+    public constructor(action: unknown, value: number);
+    public constructor(bodyState: number, movementType: TXR_move, pathType: unknown, game_object: game_object);
+    public constructor(
+      bodyState: number,
+      movementType: TXR_move,
+      pathType: unknown,
+      game_object: game_object,
+      value: f32
+    );
+    public constructor(bodyState: number, movementType: TXR_move, pathType: unknown, patrol: patrol);
+    public constructor(bodyState: number, movementType: TXR_move, pathType: unknown, patrol: patrol, value: f32);
+    public constructor(bodyState: number, movementType: TXR_move, pathType: unknown, vector: vector);
+    public constructor(bodyState: number, movementType: TXR_move, pathType: unknown, vector: vector, value: f32);
+    public constructor(vector: vector, value: number);
+    public constructor(moveAction: TXR_move, vector: vector);
+    public constructor(moveAction: TXR_move, patrol: patrol);
+    public constructor(moveAction: TXR_move, game_object: game_object);
+    public constructor(moveAction: TXR_move, vector: vector, value: number);
+    public constructor(moveAction: TXR_move, value: number, vector: vector);
+    public constructor(moveAction: TXR_move, value: number, vector: vector, value2: number);
+    public constructor(moveAction: TXR_move, patrol: patrol, value: number);
+    public constructor(moveAction: TXR_move, game_object: game_object, value: f32);
+    public constructor(moveAction: TXR_move, vector: vector, value: f32, speedParam: number);
+    public constructor(moveAction: TXR_move, patrol: patrol, value: f32, speedParam: number);
+    public constructor(moveAction: TXR_move, game_object: game_object, value: number, speedParam: unknown);
+
+    public completed(): boolean;
+    public path(EDetailPathType: number): void;
+    public move(EMovementType: number): void;
+    public position(vector: vector): void;
+    public input(EInputKeys: number): void;
+    public patrol(patrolPath: unknown, shared_str: string): void;
+    public object(game_object: game_object): void;
+    public body(EBodyState: number): void;
+  }
+
+  /**
+   * @group xr_action
+   */
+  export type TXR_move = EnumeratedStaticsValues<typeof move>;
+
+  /**
+   * @source C++ class patrol
+   * @customConstructor patrol
+   * @group xr_action
+   */
+  export class patrol extends EngineBinding {
+    // EPatrolRouteType:
+    public static readonly stop: 0;
+    // public static readonly stop: 1;
+
+    // EPatrolStartType:
+    public static readonly start: 0;
+    public static readonly continue: 1;
+    public static readonly nearest: 2;
+    public static readonly custom: 3;
+    public static readonly next: 4;
+    public static readonly dummy: -1;
+
+    public constructor(name: string);
+    public constructor(name: string);
+    public constructor(name: string, startType: TXR_patrol_type);
+    public constructor(name: string, startType: TXR_patrol_type, routeType: TXR_patrol_type);
+    public constructor(name: string, startType: TXR_patrol_type, routeType: TXR_patrol_type, bool: boolean);
+    public constructor(name: string, startType: TXR_patrol_type, routeType: TXR_patrol_type, bool: boolean, int: u32);
+
+    public count(): u32;
+    public flag(value1: u32, value2: u8): boolean;
+    public flag(value1: u32, value2: string): boolean;
+    public flags(point_index: u32): flags32;
+    public game_vertex_id(value: u32): u16;
+    public get_nearest(vector: vector): u32;
+    public index(value: string): u32;
+    public level_vertex_id(value: u32): u32;
+    public name(point_index: u32): string;
+    public point(index: u32): vector;
+    public terminal(point_index: u32): boolean;
+  }
+
+  /**
+   * @group xr_action
+   */
+  export type TXR_patrol_type = EnumeratedStaticsValues<typeof patrol>;
+
+  /**
+   * @source C++ class look
+   * @customConstructor look
+   * @group xr_action
+   */
+  export class look extends EngineBinding {
+    public static readonly cur_dir: 0;
+    public static readonly danger: 5;
+    public static readonly direction: 2;
+    public static readonly fire_point: 10;
+    public static readonly path_dir: 1;
+    public static readonly point: 3;
+    public static readonly search: 6;
+
+    public constructor();
+    public constructor(sight_type: TXR_SightType);
+    public constructor(sight_type: TXR_SightType, vector: vector);
+    public constructor(sight_type: TXR_SightType, game_object: game_object);
+    public constructor(sight_type: TXR_SightType, game_object: game_object, value: string);
+    public constructor(vector: vector, value1: f32, value2: f32);
+    public constructor(game_object: game_object, value1: f32, value2: f32);
+
+    public completed(): boolean;
+    public type(sight_type: TXR_SightType): void;
+    public object(game_object: game_object): void;
+    public bone(bode_id: string): void;
+    public direct(vector: Readonly<vector>): void;
+  }
+
+  /**
+   * @group xr_action
+   */
+  export type TXR_look = EnumeratedStaticsValues<typeof look>;
+
+  /**
+   * @source C++ class anim
+   * @customConstructor anim
+   * @group xr_action
+   */
+  export class anim extends EngineBinding {
+    // Mental state:
+    public static readonly danger: 0;
+    public static readonly free: 1;
+    public static readonly panic: 2;
+
+    // Animation state:
+    public static readonly stand_idle: 0;
+    public static readonly capture_prepare: 1;
+    public static readonly sit_idle: 2;
+    public static readonly lie_idle: 3;
+    public static readonly eat: 4;
+    public static readonly sleep: 5;
+    public static readonly rest: 6;
+    public static readonly attack: 7;
+    public static readonly look_around: 8;
+    public static readonly turn: 9;
+
+    public constructor();
+    public constructor(value: string);
+    public constructor(value1: string, value2: boolean);
+    public constructor(state: number /* enum MonsterSpace::EMentalState */);
+    public constructor(state: number /* enum MonsterSpace::EMentalState */, value: i32);
+
+    public completed(): boolean;
+    public type(state: number /* enum MonsterSpace::EMentalState */): void;
+    public anim(value: string): void;
+  }
+
+  /**
+   * @group xr_action
+   */
+  export type TXR_animation_key = EnumeratedStaticsKeys<typeof anim>;
+
+  /**
+   * @group xr_action
+   */
+  export type TXR_animation = EnumeratedStaticsValues<typeof anim>;
+
+  /**
+   * @source C++ class sound
+   * @customConstructor sound
+   * @group xr_action
+   */
+  export class sound extends EngineBinding {
+    public static readonly attack: 3;
+    public static readonly attack_hit: 4;
+    public static readonly die: 7;
+    public static readonly eat: 2;
+    public static readonly idle: 1;
+    public static readonly panic: 11;
+    public static readonly steal: 10;
+    public static readonly take_damage: 5;
+    public static readonly threaten: 9;
+
+    public constructor();
+    public constructor(value1: string, value2: string);
+    public constructor(value1: string, value2: string, vector: vector);
+    public constructor(value1: string, value2: string, vector: vector, vector2: vector);
+    public constructor(value1: string, value2: string, vector: vector, vector2: vector, value3: boolean);
+    public constructor(value1: string, vector: vector);
+    public constructor(value1: string, vector: vector, vector2: vector);
+    public constructor(value1: string, vector: vector, vector2: vector, value3: boolean);
+    public constructor(sound_object: sound_object, value1: string, vector: vector);
+    public constructor(sound_object: sound_object, value1: string, vector: vector, vector2: vector);
+    public constructor(sound_object: sound_object, value1: string, vector: vector, vector2: vector, value: boolean);
+    public constructor(sound_object: sound_object, vector1: vector);
+    public constructor(sound_object: sound_object, vector1: vector, vector2: vector);
+    public constructor(sound_object: sound_object, vector1: vector, vector2: vector, value: boolean);
+    public constructor(type: unknown /* MonsterSound::EType */);
+    public constructor(type: unknown /* enum MonsterSound::EType*/, value: number);
+    public constructor(value1: string, value2: string, type: unknown /* enum MonsterSpace::EMonsterHeadAnimType */);
+
+    public set_sound(value: string): void;
+    public set_sound(sound_object: sound_object): void;
+    public set_position(vector: vector): void;
+    public set_bone(value: string): void;
+    public set_angles(vector: vector): void;
+    public set_sound_type(type: unknown /* ESoundTypes */): void;
+    public completed(): boolean;
+  }
+
+  /**
+   * @group xr_action
+   */
+  export type TXR_sound_key = EnumeratedStaticsKeys<typeof sound>;
+
+  /**
+   * @group xr_action
+   */
+  export type TXR_sound_type = EnumeratedStaticsValues<typeof sound>;
+
+  /**
+   * @source C++ class cond
+   * @customConstructor cond
+   * @group xr_action
+   */
+  export class cond extends EngineBinding {
+    public static readonly move_end: 1;
+    public static readonly look_end: 2;
+    public static readonly anim_end: 4;
+    public static readonly sound_end: 8;
+    public static readonly object_end: 32;
+    public static readonly time_end: 64;
+    public static readonly act_end: 128;
+
+    public constructor();
+    public constructor(value: u32);
+    public constructor(value1: u32, value2: f64);
+  }
+
+  /**
+   * @group xr_action
+   */
+  export type TXR_cond = EnumeratedStaticsValues<typeof cond>;
+
+  /**
+   * @source C++ class action_base
+   * @customConstructor action_base
+   * @group xr_action
+   */
+  export class action_base extends EngineBinding {
+    public readonly object: game_object;
+    public readonly storage: property_storage;
+
+    public constructor();
+    public constructor(object: game_object | null);
+    public constructor(object: game_object | null, value: string);
+
+    public finalize(): void;
+    public add_precondition(world_property: world_property): void;
+    public execute(): void;
+    public remove_precondition(id: u32): void;
+    public setup(object: game_object, property_storage: property_storage): void;
+    public set_weight(weight: u16): void;
+    public add_effect(world_property: world_property): void;
+
+    /**
+     * With mixed / debug build allows investigation of evaluators and actions matches.
+     * Helps to debug custom actions and actions pre-conditions with state printing in log files.
+     *
+     * Note: Available only in mixed / debug engine builds, not for direct usage from lua.
+     */
+    public show(value?: string): void;
+    public initialize(): void;
+    public remove_effect(id: u32): void;
+  }
+
+  /**
+   * @source C++ class action_planner
+   * @customConstructor action_planner
+   * @group xr_action
+   */
+  export class action_planner extends EngineBinding {
+    public readonly object: game_object;
+    public readonly storage: property_storage;
+
+    public constructor();
+
+    /**
+     * @returns whether object action planner is already initialized
+     */
+    public initialized(): boolean;
+    public remove_action(value: u32): void;
+    public action(value: u32): action_base;
+    public add_action(value: u64, action_base: action_base): void;
+    public update(): void;
+    public clear(): void;
+    public evaluator(value: u32): property_evaluator;
+    public setup(game_object: game_object): void;
+    public set_goal_world_state(world_state: world_state): void;
+    public current_action(): action_base;
+    public add_evaluator(id: u32, property_evaluator: property_evaluator): void;
+    public remove_evaluator(value: u32): void;
+    public current_action_id(): u32;
+    public actual(): boolean;
+
+    public show(char: string): void;
+  }
+
+  /**
+   * @source C++ class planner_action : action_planner,action_base
+   * @customConstructor planner_action
+   * @group xr_action
+   */
+  export class planner_action extends action_planner {
+    public constructor(game_object?: game_object, value?: string);
+
+    public add_effect(world_property: world_property): unknown;
+    public add_precondition(world_property: world_property): void;
+    public execute(): unknown;
+    public finalize(): void;
+    public initialize(): void;
+    public remove_effect(id: number): void;
+    public remove_precondition(id: number): unknown;
+    public set_weight(weight: number): unknown;
+    public weight(world_state1: world_state, world_state2: world_state): u16;
+  }
+
+  /**
+   * Storage of object evaluators cached state for handling of in-game logic.
+   *
+   * @source C++ class property_storage
+   * @customConstructor property_storage
+   * @group xr_action
+   */
+  export class property_storage extends EngineBinding {
+    /**
+     * Get property evaluator value by ID.
+     *
+     * @param value - evaluator property ID
+     * @returns evaluation value
+     * @throws if property is not declared in storage
+     */
+    public property(value: u32): boolean;
+
+    public set_property(value1: u32, value2: boolean): void;
+  }
+
+  /**
+   * @source C++ class property_evaluator
+   * @customConstructor property_evaluator
+   * @group xr_action
+   */
+  export class property_evaluator extends EngineBinding {
+    public readonly object: game_object;
+    public readonly storage: property_storage;
+
+    public constructor();
+    public constructor(game_object: game_object | null);
+    public constructor(game_object: game_object | null, name: string);
+
+    public evaluate(): boolean;
+    public setup(game_object: game_object, property_storage: property_storage): void;
+  }
+
+  /**
+   * @source C++ class property_evaluator_const : property_evaluator
+   * @customConstructor property_evaluator_const
+   * @group xr_action
+   */
+  export class property_evaluator_const extends property_evaluator {
+    public constructor(value: boolean);
+  }
+
+  /**
+   * @source C++ class world_property
+   * @customConstructor world_property
+   * @group xr_action
+   */
+  export class world_property extends EngineBinding {
+    public constructor(id: u32, enabled: boolean);
+
+    public value(): boolean;
+    public condition(): u32;
+  }
+}

package/src/xr_object/xr_alife.d.ts

@@ -0,0 +1,206 @@
+declare module "xray16" {
+  /**
+   * @source C++ class alife_simulator
+   * @customConstructor alife_simulator
+   * @group xr_alife
+   */
+  export class alife_simulator {
+    public actor<T extends cse_alife_creature_actor>(): T;
+    public add_in_restriction(monster: cse_alife_monster_abstract, value: u16): void;
+    public add_out_restriction(monster: cse_alife_monster_abstract, value: u16): void;
+    public create_ammo(
+      section: string,
+      vector: vector,
+      level_vertex_id: u32,
+      game_vertex_id: u16,
+      pid: u16,
+      count: i32
+    ): cse_abstract;
+    public dont_has_info(object_id: u16, info_id: string): boolean;
+    public has_info(object_id: u16, info_id: string): boolean;
+    public iterate_objects(cb: (object: cse_alife_object) => boolean | void): void;
+    public level_id(): u32;
+    public level_name<T extends string = string>(value: i32): T;
+    public release(cse_abstract: cse_alife_object | null, flag: boolean): void;
+    public remove_all_restrictions(value: u16, type: i32 /* enum RestrictionSpace::ERestrictorTypes */): void;
+    public remove_in_restriction(monster: cse_alife_monster_abstract, value: u16): void;
+    public remove_out_restriction(monster: cse_alife_monster_abstract, value: u16): void;
+    public set_interactive(value1: u16, value2: boolean): void;
+    public set_switch_distance(distance: f32): void;
+    public set_switch_offline(value1: u16, value2: boolean): void;
+    public set_switch_online(value1: u16, value2: boolean): void;
+    public spawn_id(value: u32): u16;
+    public story_object(value: u32): cse_alife_object;
+    /**
+     * @returns alife server-client switch distance
+     */
+    public switch_distance(): f32;
+    /**
+     * Set alife server-client switch distance.
+     *
+     * @param distance - distance to set
+     */
+    public switch_distance(distance: f32): void;
+    /**
+     * Set count of object updated in alife per one tick.
+     *
+     * @param count - count of objects to update per tick
+     */
+    public set_objects_per_update(count: u16): void;
+    public teleport_object(level_vertex_id: u16, game_vertex_id: u16, int: u32, vector: vector): void;
+    public valid_object_id(value: u16): boolean;
+
+    public kill_entity(monster1: cse_alife_monster_abstract, value?: u16, monster2?: cse_alife_monster_abstract): void;
+
+    public object<T extends cse_alife_object = cse_alife_object>(id: number, value2?: boolean): T | null;
+
+    public create<T extends cse_alife_object = cse_alife_object>(value: u32): T;
+    public create<T extends cse_alife_object = cse_alife_object>(
+      item_section: string,
+      position: vector,
+      level_vertex_id: u32,
+      game_vertex_id: u32,
+      pid?: i32
+    ): T;
+  }
+
+  /**
+   * @source C++ class CALifeSmartTerrainTask
+   * @customConstructor CALifeSmartTerrainTask
+   * @group xr_alife
+   */
+  export class CALifeSmartTerrainTask {
+    public constructor(patrol_path_name: string, patrol_point_index?: u32);
+    public constructor(game_vertex_id: u16, level_vertex_id: u32);
+
+    public level_vertex_id(): u16;
+    public game_vertex_id(): u16;
+    public position(): vector;
+  }
+
+  /**
+   * @source C++ class CALifeMonsterBrain
+   * @customConstructor CALifeMonsterBrain
+   * @group xr_alife
+   */
+  export class CAILifeMonsterBrain {
+    public constructor(object: unknown);
+
+    public select_task(forced?: boolean): void;
+    public process_task(): void;
+    public default_behaviour(): void;
+
+    public can_choose_alife_tasks(): boolean;
+    public can_choose_alife_tasks(value: boolean): void;
+
+    public on_state_write(packet: net_packet): void;
+    public on_state_read(packet: net_packet): void;
+    public on_register(): void;
+    public on_unregister(): void;
+    public on_location_change(): void;
+    public on_switch_online(): void;
+    public on_switch_offline(): void;
+
+    public update(forced?: boolean): void;
+    public update_script(): void;
+
+    public perform_attack(): boolean;
+    public action_type(tpALifeSchedulable: unknown, index: number, mutual_detection: boolean): unknown;
+    public object(): unknown;
+    public movement(): unknown;
+    public smart_terrain(): unknown;
+  }
+
+  /**
+   * @source C++ class CALifeMonsterBrain
+   * @customConstructor CALifeMonsterBrain
+   * @group xr_alife
+   */
+  export class CALifeMonsterBrain {
+    public movement(): CALifeMonsterMovementManager;
+    public update(): void;
+    public can_choose_alife_tasks(): boolean;
+    public can_choose_alife_tasks(can_choose: boolean): void;
+  }
+
+  /**
+   * @source C++ class CALifeHumanBrain : CALifeMonsterBrain
+   * @customConstructor CALifeHumanBrain
+   * @group xr_alife
+   */
+  export class CALifeHumanBrain extends CALifeMonsterBrain {}
+
+  /**
+   * @source C++ class CALifeMonsterDetailPathManager
+   * @customConstructor CALifeMonsterDetailPathManager
+   * @group xr_alife
+   */
+  export class CALifeMonsterDetailPathManager {
+    public completed(): boolean;
+    public target(a: number, b: number, vector: vector): void;
+    public target(task_id: number): void;
+    public target(task: CALifeSmartTerrainTask): void;
+    public failed(): boolean;
+    public speed(number: f32): f32;
+    public speed(): f32;
+    public actual(): boolean;
+  }
+
+  /**
+   * @source C++ class CALifeMonsterMovementManager
+   * @customConstructor CALifeMonsterMovementManager
+   * @group xr_alife
+   */
+  export class CALifeMonsterMovementManager {
+    public completed(): boolean;
+    public patrol(): CALifeMonsterPatrolPathManager;
+    public actual(): boolean;
+    public path_type(): number; /* EPathType */
+    public detail(): CALifeMonsterDetailPathManager;
+  }
+
+  /**
+   * @source C++ class CALifeMonsterPatrolPathManager
+   * @customConstructor CALifeMonsterPatrolPathManager
+   * @group xr_alife
+   */
+  export class CALifeMonsterPatrolPathManager {
+    public path(string: string): void;
+    public target_game_vertex_id(): u16;
+    public target_level_vertex_id(): u16;
+    public target_position(): vector;
+    public completed(): boolean;
+    public route_type(type: u32 /* const enum PatrolPathManager::EPatrolRouteType */): u32;
+    public route_type(): u32;
+    public use_randomness(enabled: boolean): boolean;
+    public use_randomness(): boolean;
+    public start_type(type: u32 /* const enum PatrolPathManager::EPatrolStartType */): u32;
+    public start_type(): u32;
+    public start_vertex_index(index: u32): void;
+    public actual(): boolean;
+  }
+
+  /**
+   * @source C++ class cover_point
+   * @customConstructor cover_point
+   * @group xr_alife
+   */
+  export class cover_point {
+    private constructor();
+
+    public level_vertex_id(): u32;
+    public is_smart_cover(): boolean;
+    public position(): vector;
+  }
+
+  /**
+   * @source C++ class client_spawn_manager
+   * @customConstructor client_spawn_manager
+   * @group xr_alife
+   */
+  export class client_spawn_manager {
+    public remove(number1: u16, number2: u16): void;
+    public add(number1: u16, number2: u16, cb: () => void): void;
+    public add(number1: u16, number2: u16, cb: () => void, object: XR_object): void;
+  }
+}