XRF X-Ray 16 SDK

Appearance

Class: MockPropertiesHelper ​

Mock of the X-Ray engine C++ properties_helper class.

Extends ​

Implements ​

  • properties_helper

Accessors ​

__name ​

Get Signature ​

ts
get __name(): string;
Returns ​

string

Implementation of ​

ts
properties_helper.__name

Inherited from ​

MockLuabindClass.__name

__name ​

Get Signature ​

ts
get static __name(): string;
Returns ​

string

Inherited from ​

MockLuabindClass.__name

Constructors ​

Constructor ​

ts
new MockPropertiesHelper(): MockPropertiesHelper;

Returns ​

MockPropertiesHelper

Inherited from ​

MockLuabindClass.constructor

Methods ​

create() ​

ts
static create(): MockPropertiesHelper;

Returns ​

MockPropertiesHelper

Overrides ​

MockLuabindClass.create

mock() ​

ts
static mock(): properties_helper;

Returns ​

properties_helper

Overrides ​

MockLuabindClass.mock

Properties ​

create_angle ​

ts
create_angle: MockedFunction<(items: prop_item_vec, key: string, object: object, name: string, min?: number, max?: number, increment?: number, decimals?: number) => float_value>;

Create an angle property bound to a float field.

Implementation of ​

ts
properties_helper.create_angle

create_bool ​

ts
create_bool: MockedFunction<(items: prop_item_vec, key: string, object: object, table: object, name: string) => bool_value>;

Create a boolean property bound to table[name] and owned by object.

Implementation of ​

ts
properties_helper.create_bool

create_button ​

ts
create_button: MockedFunction<(items: prop_item_vec, key: string, value: string, flags: number) => button_value>;

Create editor-only utility rows.

Implementation of ​

ts
properties_helper.create_button

create_canvas ​

ts
create_canvas: MockedFunction<(items: prop_item_vec, key: string, value: string, height: number) => canvas_value>;

Implementation of ​

ts
properties_helper.create_canvas

create_caption ​

ts
create_caption: MockedFunction<(items: prop_item_vec, key: string, value: string) => caption_value>;

Implementation of ​

ts
properties_helper.create_caption

create_choose ​

ts
create_choose: MockedFunction<(items: prop_item_vec, key: string, object: object, name: string, mode: number, path?: string, fillParam?: string, subItemCount?: number) => choose_value>;

Create an asset/object chooser property bound to a string field.

Implementation of ​

ts
properties_helper.create_choose

create_color ​

ts
create_color: MockedFunction<(items: prop_item_vec, key: string, object: object, name: string) => u32_value>;

Create a 32-bit packed color property bound to an unsigned integer field.

Implementation of ​

ts
properties_helper.create_color

create_fcolor ​

ts
create_fcolor: MockedFunction<(items: prop_item_vec, key: string, object: object, name: string) => color_value>;

Create a float color property bound to an Fcolor field.

Implementation of ​

ts
properties_helper.create_fcolor

create_flag16 ​

ts
create_flag16: MockedFunction<(items: prop_item_vec, key: string, object: object, name: string, mask: number, offCaption?: string, onCaption?: string, flags?: number) => flag16_value>;

Implementation of ​

ts
properties_helper.create_flag16

create_flag32 ​

ts
create_flag32: MockedFunction<(items: prop_item_vec, key: string, object: object, name: string, mask: number, offCaption?: string, onCaption?: string, flags?: number) => flag32_value>;

Implementation of ​

ts
properties_helper.create_flag32

create_flag8 ​

ts
create_flag8: MockedFunction<(items: prop_item_vec, key: string, object: object, name: string, mask: number, offCaption?: string, onCaption?: string, flags?: number) => flag8_value>;

Create flag properties bound to integer flag fields.

Implementation of ​

ts
properties_helper.create_flag8

create_float ​

ts
create_float: MockedFunction<(items: prop_item_vec, key: string, object: object, name: string, min?: number, max?: number, increment?: number, decimals?: number) => float_value>;

Create numeric properties bound to object fields.

Implementation of ​

ts
properties_helper.create_float

create_list ​

ts
create_list: MockedFunction<(items: prop_item_vec, key: string, object: object, name: string, tokens: rtoken_list) => list_value>;

Create a runtime token list property bound to a string field.

Implementation of ​

ts
properties_helper.create_list

create_s16 ​

ts
create_s16: MockedFunction<(items: prop_item_vec, key: string, object: object, name: string, min?: number, max?: number, increment?: number) => s16_value>;

Implementation of ​

ts
properties_helper.create_s16

create_s32 ​

ts
create_s32: MockedFunction<(items: prop_item_vec, key: string, object: object, name: string, min?: number, max?: number, increment?: number) => s32_value>;

Implementation of ​

ts
properties_helper.create_s32

create_text ​

ts
create_text: MockedFunction<(items: prop_item_vec, key: string, object: object, name: string) => text_value>;

Implementation of ​

ts
properties_helper.create_text

create_time ​

ts
create_time: MockedFunction<(items: prop_item_vec, key: string, object: object, name: string, min?: number, max?: number) => float_value>;

Create a time property bound to a float field.

Implementation of ​

ts
properties_helper.create_time

create_token16 ​

ts
create_token16: MockedFunction<(items: prop_item_vec, key: string, object: object, name: string, tokens: token_list) => token16_value>;

Implementation of ​

ts
properties_helper.create_token16

create_token32 ​

ts
create_token32: MockedFunction<(items: prop_item_vec, key: string, object: object, name: string, tokens: token_list) => token32_value>;

Implementation of ​

ts
properties_helper.create_token32

create_token8 ​

ts
create_token8: MockedFunction<(items: prop_item_vec, key: string, object: object, name: string, tokens: token_list) => token8_value>;

Create token properties bound to integer fields.

Implementation of ​

ts
properties_helper.create_token8

create_u16 ​

ts
create_u16: MockedFunction<(items: prop_item_vec, key: string, object: object, name: string, min?: number, max?: number, increment?: number) => u16_value>;

Implementation of ​

ts
properties_helper.create_u16

create_u32 ​

ts
create_u32: MockedFunction<(items: prop_item_vec, key: string, object: object, name: string, min?: number, max?: number, increment?: number) => u32_value>;

Implementation of ​

ts
properties_helper.create_u32

create_u8 ​

ts
create_u8: MockedFunction<(items: prop_item_vec, key: string, object: object, name: string, min?: number, max?: number, increment?: number) => u8_value>;

Implementation of ​

ts
properties_helper.create_u8

create_vangle ​

ts
create_vangle: MockedFunction<(items: prop_item_vec, key: string, object: object, name: string, min?: number, max?: number, increment?: number, decimals?: number) => vector_value>;

Create a 3-axis angle property bound to an Fvector field.

Implementation of ​

ts
properties_helper.create_vangle

create_vcolor ​

ts
create_vcolor: MockedFunction<(items: prop_item_vec, key: string, object: object, name: string) => vector_value>;

Create a vector color property bound to an Fvector field.

Implementation of ​

ts
properties_helper.create_vcolor

create_vector ​

ts
create_vector: MockedFunction<(items: prop_item_vec, key: string, object: object, name: string, min?: number, max?: number, increment?: number, decimals?: number) => vector_value>;

Create a vector property bound to an Fvector field.

Implementation of ​

ts
properties_helper.create_vector

float_on_after_edit ​

ts
float_on_after_edit: MockedFunction<(sender: prop_value, value: number) => LuaMultiReturn<[boolean, number]>>;

Standard editor callbacks used by property rows with luabind out-parameters.

Implementation of ​

ts
properties_helper.float_on_after_edit

float_on_before_edit ​

ts
float_on_before_edit: MockedFunction<(sender: prop_value, value: number) => number>;

Implementation of ​

ts
properties_helper.float_on_before_edit

name_after_edit ​

ts
name_after_edit: MockedFunction<(sender: prop_value, value: string) => LuaMultiReturn<[boolean, string]>>;

Implementation of ​

ts
properties_helper.name_after_edit

name_before_edit ​

ts
name_before_edit: MockedFunction<(sender: prop_value, value: string) => string>;

Implementation of ​

ts
properties_helper.name_before_edit

vector_on_after_edit ​

ts
vector_on_after_edit: MockedFunction<(sender: prop_value, value: vector) => boolean>;

Implementation of ​

ts
properties_helper.vector_on_after_edit

vector_on_before_edit ​

ts
vector_on_before_edit: MockedFunction<(sender: prop_value, value: vector) => vector>;

Implementation of ​

ts
properties_helper.vector_on_before_edit