Kryzeth Standard Library

data.equipment-grid

Methods17

function EquipmentGrid.__call(name: string) -> grid StdLib.Data.EquipmentGrid

Looks up and wraps an equipment grid by name.

Parameters
namestring

Equipment-grid prototype name

function EquipmentGrid.update_width(width: integer) -> updated boolean

Sets the equipment grid's width.

Parameters
widthinteger

Grid width

Returns
updatedboolean

Whether the equipment grid was valid and updated

function EquipmentGrid.update_height(height: integer) -> updated boolean

Sets the equipment grid's height.

Parameters
heightinteger

Grid height

Returns
updatedboolean

Whether the equipment grid was valid and updated

function EquipmentGrid.update_size(width: integer, height: integer) -> updated boolean

Sets the equipment grid's width and height.

Parameters
widthinteger

Grid width

heightinteger

Grid height

Returns
updatedboolean

Whether the equipment grid was valid and updated

function EquipmentGrid.set_category(category_name: string) -> self

Replaces the equipment categories accepted by this grid with one category.

Parameters
category_namestring

Equipment category name

Returns
self
function EquipmentGrid.set_cat(category_name: string) -> self
Parameters
category_namestring

Equipment category name

Returns
self
function EquipmentGrid.set_categories(category_list: string[]) -> self

Replaces the equipment categories accepted by this grid.

Parameters
category_liststring[]

Equipment categories

Returns
self
function EquipmentGrid.set_cats(category_list: string[]) -> self
Parameters
category_liststring[]

Equipment categories

Returns
self
function EquipmentGrid.add_category(category_name: string) -> self

Adds one equipment category.

Parameters
category_namestring

Equipment category name

Returns
self
function EquipmentGrid.add_cat(category_name: string) -> self
Parameters
category_namestring

Equipment category name

Returns
self
function EquipmentGrid.add_categories(category_list: string[]) -> self

Adds multiple equipment categories.

Parameters
category_liststring[]

Equipment categories

Returns
self
function EquipmentGrid.add_cats(category_list: string[]) -> self
Parameters
category_liststring[]

Equipment categories

Returns
self
function EquipmentGrid.remove_category(category_name: string) -> self

Removes one equipment category.

Parameters
category_namestring

Equipment category name

Returns
self
function EquipmentGrid.rem_cat(category_name: string) -> self
Parameters
category_namestring

Equipment category name

Returns
self
function EquipmentGrid.rem_category(category_name: string) -> self
Parameters
category_namestring

Equipment category name

Returns
self
function EquipmentGrid.remove_categories(category_list: string[]) -> self

Removes multiple equipment categories.

Parameters
category_liststring[]

Equipment categories

Returns
self
function EquipmentGrid.rem_cats(category_list: string[]) -> self
Parameters
category_liststring[]

Equipment categories

Returns
self

Fields6

EquipmentGrid.width : integer
EquipmentGrid.height : integer
EquipmentGrid.equipment_categories : string[]
EquipmentGrid.locked : nil | boolean
EquipmentGrid.__class: string = "EquipmentGrid"
EquipmentGrid.__index : unknown