Class: properties_helper

Global editor properties helper.

Source

C++ class properties_helper

Custom Constructor

properties_helper

Remarks

Only available when the editor property helper library is loaded. Outside that context the native accessor logs an error and returns no usable helper.

Extends

properties_list_helper

Constructors

Constructor

new properties_helper(): properties_helper;

Returns

properties_helper

Inherited from

properties_list_helper.constructor

Methods

create_angle()

create_angle(
   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.

Parameters

Parameter	Type
`items`	`prop_item_vec`
`key`	`string`
`object`	`object`
`name`	`string`
`min?`	`number`
`max?`	`number`
`increment?`	`number`
`decimals?`	`number`

Returns

float_value

Inherited from

properties_list_helper.create_angle

create_bool()

create_bool(
   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.

Parameters

Parameter	Type
`items`	`prop_item_vec`
`key`	`string`
`object`	`object`
`table`	`object`
`name`	`string`

Returns

bool_value

Inherited from

properties_list_helper.create_bool

create_button()

create_button(
   items: prop_item_vec, 
   key: string, 
   value: string, 
   flags: number): button_value;

Create editor-only utility rows.

Parameters

Parameter	Type
`items`	`prop_item_vec`
`key`	`string`
`value`	`string`
`flags`	`number`

Returns

button_value

Inherited from

properties_list_helper.create_button

create_canvas()

create_canvas(
   items: prop_item_vec, 
   key: string, 
   value: string, 
   height: number): canvas_value;

Parameters

Parameter	Type
`items`	`prop_item_vec`
`key`	`string`
`value`	`string`
`height`	`number`

Returns

canvas_value

Inherited from

properties_list_helper.create_canvas

create_caption()

create_caption(
   items: prop_item_vec, 
   key: string, 
   value: string): caption_value;

Parameters

Parameter	Type
`items`	`prop_item_vec`
`key`	`string`
`value`	`string`

Returns

caption_value

Inherited from

properties_list_helper.create_caption

create_choose()

create_choose(
   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.

Parameters

Parameter	Type
`items`	`prop_item_vec`
`key`	`string`
`object`	`object`
`name`	`string`
`mode`	`number`
`path?`	`string`
`fillParam?`	`string`
`subItemCount?`	`number`

Returns

choose_value

Inherited from

properties_list_helper.create_choose

create_color()

create_color(
   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.

Parameters

Parameter	Type
`items`	`prop_item_vec`
`key`	`string`
`object`	`object`
`name`	`string`

Returns

u32_value

Inherited from

properties_list_helper.create_color

create_fcolor()

create_fcolor(
   items: prop_item_vec, 
   key: string, 
   object: object, 
   name: string): color_value;

Create a float color property bound to an Fcolor field.

Parameters

Parameter	Type
`items`	`prop_item_vec`
`key`	`string`
`object`	`object`
`name`	`string`

Returns

color_value

Inherited from

properties_list_helper.create_fcolor

create_flag16()

create_flag16(
   items: prop_item_vec, 
   key: string, 
   object: object, 
   name: string, 
   mask: number, 
   offCaption?: string, 
   onCaption?: string, 
   flags?: number): flag16_value;

Parameters

Parameter	Type
`items`	`prop_item_vec`
`key`	`string`
`object`	`object`
`name`	`string`
`mask`	`number`
`offCaption?`	`string`
`onCaption?`	`string`
`flags?`	`number`

Returns

flag16_value

Inherited from

properties_list_helper.create_flag16

create_flag32()

create_flag32(
   items: prop_item_vec, 
   key: string, 
   object: object, 
   name: string, 
   mask: number, 
   offCaption?: string, 
   onCaption?: string, 
   flags?: number): flag32_value;

Parameters

Parameter	Type
`items`	`prop_item_vec`
`key`	`string`
`object`	`object`
`name`	`string`
`mask`	`number`
`offCaption?`	`string`
`onCaption?`	`string`
`flags?`	`number`

Returns

flag32_value

Inherited from

properties_list_helper.create_flag32

create_flag8()

create_flag8(
   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.

Parameters

Parameter	Type
`items`	`prop_item_vec`
`key`	`string`
`object`	`object`
`name`	`string`
`mask`	`number`
`offCaption?`	`string`
`onCaption?`	`string`
`flags?`	`number`

Returns

flag8_value

Inherited from

properties_list_helper.create_flag8

create_float()

create_float(
   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.

Parameters

Parameter	Type
`items`	`prop_item_vec`
`key`	`string`
`object`	`object`
`name`	`string`
`min?`	`number`
`max?`	`number`
`increment?`	`number`
`decimals?`	`number`

Returns

float_value

Inherited from

properties_list_helper.create_float

create_list()

create_list(
   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.

Parameters

Parameter	Type
`items`	`prop_item_vec`
`key`	`string`
`object`	`object`
`name`	`string`
`tokens`	`rtoken_list`

Returns

list_value

Inherited from

properties_list_helper.create_list

create_s16()

create_s16(
   items: prop_item_vec, 
   key: string, 
   object: object, 
   name: string, 
   min?: number, 
   max?: number, 
   increment?: number): s16_value;

Parameters

Parameter	Type
`items`	`prop_item_vec`
`key`	`string`
`object`	`object`
`name`	`string`
`min?`	`number`
`max?`	`number`
`increment?`	`number`

Returns

s16_value

Inherited from

properties_list_helper.create_s16

create_s32()

create_s32(
   items: prop_item_vec, 
   key: string, 
   object: object, 
   name: string, 
   min?: number, 
   max?: number, 
   increment?: number): s32_value;

Parameters

Parameter	Type
`items`	`prop_item_vec`
`key`	`string`
`object`	`object`
`name`	`string`
`min?`	`number`
`max?`	`number`
`increment?`	`number`

Returns

s32_value

Inherited from

properties_list_helper.create_s32

create_text()

create_text(
   items: prop_item_vec, 
   key: string, 
   object: object, 
   name: string): text_value;

Parameters

Parameter	Type
`items`	`prop_item_vec`
`key`	`string`
`object`	`object`
`name`	`string`

Returns

text_value

Inherited from

properties_list_helper.create_text

create_time()

create_time(
   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.

Parameters

Parameter	Type
`items`	`prop_item_vec`
`key`	`string`
`object`	`object`
`name`	`string`
`min?`	`number`
`max?`	`number`

Returns

float_value

Inherited from

properties_list_helper.create_time

create_token16()

create_token16(
   items: prop_item_vec, 
   key: string, 
   object: object, 
   name: string, 
   tokens: token_list): token16_value;

Parameters

Parameter	Type
`items`	`prop_item_vec`
`key`	`string`
`object`	`object`
`name`	`string`
`tokens`	`token_list`

Returns

token16_value

Inherited from

properties_list_helper.create_token16

create_token32()

create_token32(
   items: prop_item_vec, 
   key: string, 
   object: object, 
   name: string, 
   tokens: token_list): token32_value;

Parameters

Parameter	Type
`items`	`prop_item_vec`
`key`	`string`
`object`	`object`
`name`	`string`
`tokens`	`token_list`

Returns

token32_value

Inherited from

properties_list_helper.create_token32

create_token8()

create_token8(
   items: prop_item_vec, 
   key: string, 
   object: object, 
   name: string, 
   tokens: token_list): token8_value;

Create token properties bound to integer fields.

Parameters

Parameter	Type
`items`	`prop_item_vec`
`key`	`string`
`object`	`object`
`name`	`string`
`tokens`	`token_list`

Returns

token8_value

Inherited from

properties_list_helper.create_token8

create_u16()

create_u16(
   items: prop_item_vec, 
   key: string, 
   object: object, 
   name: string, 
   min?: number, 
   max?: number, 
   increment?: number): u16_value;

Parameters

Parameter	Type
`items`	`prop_item_vec`
`key`	`string`
`object`	`object`
`name`	`string`
`min?`	`number`
`max?`	`number`
`increment?`	`number`

Returns

u16_value

Inherited from

properties_list_helper.create_u16

create_u32()

create_u32(
   items: prop_item_vec, 
   key: string, 
   object: object, 
   name: string, 
   min?: number, 
   max?: number, 
   increment?: number): u32_value;

Parameters

Parameter	Type
`items`	`prop_item_vec`
`key`	`string`
`object`	`object`
`name`	`string`
`min?`	`number`
`max?`	`number`
`increment?`	`number`

Returns

u32_value

Inherited from

properties_list_helper.create_u32

create_u8()

create_u8(
   items: prop_item_vec, 
   key: string, 
   object: object, 
   name: string, 
   min?: number, 
   max?: number, 
   increment?: number): u8_value;

Parameters

Parameter	Type
`items`	`prop_item_vec`
`key`	`string`
`object`	`object`
`name`	`string`
`min?`	`number`
`max?`	`number`
`increment?`	`number`

Returns

u8_value

Inherited from

properties_list_helper.create_u8

create_vangle()

create_vangle(
   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.

Parameters

Parameter	Type
`items`	`prop_item_vec`
`key`	`string`
`object`	`object`
`name`	`string`
`min?`	`number`
`max?`	`number`
`increment?`	`number`
`decimals?`	`number`

Returns

vector_value

Inherited from

properties_list_helper.create_vangle

create_vcolor()

create_vcolor(
   items: prop_item_vec, 
   key: string, 
   object: object, 
   name: string): vector_value;

Create a vector color property bound to an Fvector field.

Parameters

Parameter	Type
`items`	`prop_item_vec`
`key`	`string`
`object`	`object`
`name`	`string`

Returns

vector_value

Inherited from

properties_list_helper.create_vcolor

create_vector()

create_vector(
   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.

Parameters

Parameter	Type
`items`	`prop_item_vec`
`key`	`string`
`object`	`object`
`name`	`string`
`min?`	`number`
`max?`	`number`
`increment?`	`number`
`decimals?`	`number`

Returns

vector_value

Inherited from

properties_list_helper.create_vector

float_on_after_edit()

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

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

Parameters

Parameter	Type
`sender`	`prop_value`
`value`	`number`

Returns

LuaMultiReturn<[boolean, number]>

Inherited from

properties_list_helper.float_on_after_edit

float_on_before_edit()

float_on_before_edit(sender: prop_value, value: number): number;

Parameters

Parameter	Type
`sender`	`prop_value`
`value`	`number`

Returns

number

Inherited from

properties_list_helper.float_on_before_edit

name_after_edit()

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

Parameters

Parameter	Type
`sender`	`prop_value`
`value`	`string`

Returns

LuaMultiReturn<[boolean, string]>

Inherited from

properties_list_helper.name_after_edit

name_before_edit()

name_before_edit(sender: prop_value, value: string): string;

Parameters

Parameter	Type
`sender`	`prop_value`
`value`	`string`

Returns

string

Inherited from

properties_list_helper.name_before_edit

vector_on_after_edit()

vector_on_after_edit(sender: prop_value, value: vector): boolean;

Parameters

Parameter	Type
`sender`	`prop_value`
`value`	`vector`

Returns

boolean

Inherited from

properties_list_helper.vector_on_after_edit

vector_on_before_edit()

vector_on_before_edit(sender: prop_value, value: vector): vector;

Parameters

Parameter	Type
`sender`	`prop_value`
`value`	`vector`

Returns

vector

Inherited from

properties_list_helper.vector_on_before_edit

Properties

__name

readonly __name: string;

LuaBind instance constructor name.

Inherited from

properties_list_helper.__name

__name

readonly static __name: string;

LuaBind class constructor name.

Inherited from

properties_list_helper.__name

Class: properties_helper ​

Source ​

Custom Constructor ​

Remarks ​

Extends ​

Constructors ​

Constructor ​

Returns ​

Inherited from ​

Methods ​

create_angle() ​

Parameters ​

Returns ​

Inherited from ​

create_bool() ​

Parameters ​

Returns ​

Inherited from ​

create_button() ​

Parameters ​

Returns ​

Inherited from ​

create_canvas() ​

Parameters ​

Returns ​

Inherited from ​

create_caption() ​

Parameters ​

Returns ​

Inherited from ​

create_choose() ​

Parameters ​

Returns ​

Inherited from ​

create_color() ​

Parameters ​

Returns ​

Inherited from ​

create_fcolor() ​

Parameters ​

Returns ​

Inherited from ​

create_flag16() ​

Parameters ​

Returns ​

Inherited from ​

create_flag32() ​

Parameters ​

Returns ​

Inherited from ​

create_flag8() ​

Parameters ​

Returns ​

Inherited from ​

create_float() ​

Parameters ​

Returns ​

Inherited from ​

create_list() ​

Parameters ​

Returns ​

Inherited from ​

create_s16() ​

Parameters ​

Returns ​

Inherited from ​

create_s32() ​

Parameters ​

Returns ​

Inherited from ​

create_text() ​

Parameters ​

Returns ​

Inherited from ​

create_time() ​

Parameters ​

Returns ​

Inherited from ​

create_token16() ​

Parameters ​

Class: properties_helper

Source

Custom Constructor

Remarks

Extends

Constructors

Constructor

Returns

Inherited from

Methods

create_angle()

Parameters

Returns

Inherited from

create_bool()

Parameters

Returns

Inherited from

create_button()

Parameters

Returns

Inherited from

create_canvas()

Parameters

Returns

Inherited from

create_caption()

Parameters

Returns

Inherited from

create_choose()

Parameters

Returns

Inherited from

create_color()

Parameters

Returns

Inherited from

create_fcolor()

Parameters

Returns

Inherited from

create_flag16()

Parameters

Returns

Inherited from

create_flag32()

Parameters

Returns

Inherited from

create_flag8()

Parameters

Returns

Inherited from

create_float()

Parameters

Returns

Inherited from

create_list()

Parameters

Returns

Inherited from

create_s16()

Parameters

Returns

Inherited from

create_s32()

Parameters

Returns

Inherited from

create_text()

Parameters

Returns

Inherited from

create_time()

Parameters

Returns

Inherited from

create_token16()

Parameters