PointShop Functions

These functions are part of the global PS table and provide utility functions.

PS:ValidateItems(items)

Arguments: Any items
Returns: Table
Realm: Shared
Description: Takes a value and validates by ensuring it is a table and removing an non-existent items.

local items = PS:ValidateItems(items)

PS:ValidatePoints(points)

Arguments: Any points
Returns: Number
Realm: Shared
Description: Takes a value and validates by ensuring it is a number and more than -1.

local points = PS:ValidatePoints(points)

PS:FindCategoryByName(cat_name)

Arguments: String cat_name
Returns: CATEGORY
Realm: Shared
Description: Finds a category with the passed name.

local CATEGORY = PS:FindCategoryByName('test')

PS:ToggleMenu()

Realm: Client
Description: Toggles the PointShop menu open or closed.

PS:ToggleMenu()

PS:SetHoverItem(item_id)

Arguments: String item_id
Realm: Client
Description: Sets the currently hovered item in the PointShop menu.

PS:SetHoverItem('conehat')

PS:RemoveHoverItem()

Realm: Client
Description: Unsets the hovered item in the PointShop menu.

PS:RemoveHoverItem()

PS:ShowColorChooser(item, modifications)

Arguments: ITEM item, Table modifications
Realm: Client
Description: Opens the color chooser window for an item.

function ITEM:Modify(modifications)
    PS:ShowColorChooser(self, modifications)
end

PS:SendModifications(item_id, modifications)

Arguments: String item_id Table modifications
Realm: Client
Description: Sends modifications for an item to the server.

chooser.OnChoose = function(color)
    modifications.color = color
    self:SendModifications(item.ID, modifications)
end