x_bows API documentation

x_bows

• Index

Contents

• Tables
• Methods

Classes

• XBows
• XBowsQuiver

Topics

• README

Class XBowsQuiver

XBowsQuiver class extended from XBows

Info:

• License: LGPL-2.1-or-later
• Author: SaKeL

Tables

XBowsQuiver.hud_item_ids

IDs of added HUDs

XBowsQuiver.after_job

after job tables

Methods

XBowsQuiver:close_quiver (self, player, quiver_id)

Close one or all open quivers in players inventory

XBowsQuiver:get_replacement_item (self, from_stack, to_item_name)

Swap item in player inventory indicating open quiver.

XBowsQuiver:get_itemstack_arrow_from_quiver (self, player)

Gets arrow from quiver

XBowsQuiver:remove_hud (self, player)

Remove all added HUDs

XBowsQuiver:udate_or_create_hud (self, player, inv_list, idx)

Update or create quiver HUD

XBowsQuiver:get_or_create_detached_inv (self, quiver_id, player_name, quiver_items)

Get existing detached inventory or create new one

XBowsQuiver:get_formspec (self, name)

Create formspec

XBowsQuiver:get_string_from_inv (self, inv)

Convert inventory of itemstacks to serialized string

XBowsQuiver:set_string_to_inv (self, inv, str)

Set items from serialized string to inventory

XBowsQuiver:save (self, inv, player, quiver_is_closed)

Save quiver inventory to itemstack meta

XBowsQuiver:quiver_can_allow (self, inv, player)

Check if we are allowing actions in the correct quiver inventory

Tables

XBowsQuiver.hud_item_ids

IDs of added HUDs

XBowsQuiver.after_job

after job tables

Methods

XBowsQuiver:close_quiver (self, player, quiver_id)

Close one or all open quivers in players inventory

Parameters:

• self XBowsQuiver
• player ObjectRef
• quiver_id ? string If nil then all open quivers will be closed

Returns:

nil

XBowsQuiver:get_replacement_item (self, from_stack, to_item_name)

Swap item in player inventory indicating open quiver. Preserve all ItemStack definition and meta.

Parameters:

• self XBowsQuiver
• from_stack ItemStack transfer data from this item
• to_item_name string transfer data to this item

Returns:

ItemStack ItemStack replacement item

XBowsQuiver:get_itemstack_arrow_from_quiver (self, player)

Gets arrow from quiver

Parameters:

• self XBowsQuiver
• player ObjectRef

Returns:

{["found_arrow_stack"]: ItemStack|nil, ["quiver_id"]: string|nil, ["quiver_name"]: string|nil, ["found_arrow_stack_idx"]: number}

XBowsQuiver:remove_hud (self, player)

Remove all added HUDs

Parameters:

• self XBowsQuiver
• player ObjectRef

Returns:

nil

XBowsQuiver:udate_or_create_hud (self, player, inv_list, idx)

Update or create quiver HUD

Parameters:

• self XBowsQuiver
• player ObjectRef
• inv_list ItemStack[]
• idx ? number

Returns:

nil

XBowsQuiver:get_or_create_detached_inv (self, quiver_id, player_name, quiver_items)

Get existing detached inventory or create new one

Parameters:

• self XBowsQuiver
• quiver_id string
• player_name string
• quiver_items ? string

Returns:

InvRef|unknown

XBowsQuiver:get_formspec (self, name)

Create formspec

Parameters:

• self XBowsQuiver
• name string name of the form

Returns:

string

XBowsQuiver:get_string_from_inv (self, inv)

Convert inventory of itemstacks to serialized string

Parameters:

• self XBowsQuiver
• inv InvRef

Returns:

{['inv_string']: string, ['content_description']: string}

XBowsQuiver:set_string_to_inv (self, inv, str)

Set items from serialized string to inventory

Parameters:

• self XBowsQuiver
• inv InvRef inventory to add items to
• str string previously stringified inventory of itemstacks

Returns:

nil

XBowsQuiver:save (self, inv, player, quiver_is_closed)

Save quiver inventory to itemstack meta

Parameters:

• self XBowsQuiver
• inv InvRef
• player ObjectRef
• quiver_is_closed ? boolean

Returns:

nil

XBowsQuiver:quiver_can_allow (self, inv, player)

Check if we are allowing actions in the correct quiver inventory

Parameters:

• self XBowsQuiver
• inv InvRef
• player ObjectRef

Returns:

boolean

generated by LDoc 1.4.6 Last updated 2022-10-22 22:59:29