cw.salesmenu classclient

Part of Salesmen

Defines the client-side cw.salesmenu library, which holds the data of the salesman whose trade menu is open.

The data arrives in the Salesmenu Cable message; the getters expose the salesman entity, its sells and buys lists, stock, cash, prices and trade restrictions to the cwSalesmenu panel.

Summary

Methods

BuyInShipments()client
Returns whether the open salesman sells items in whole shipments (the item's batch size).
GetBuyRate()client
Returns the percentage of an item's cost the open salesman pays when buying it.
GetBuys()client
Returns the items the open salesman buys.
GetCash()client
Returns the cash the open salesman has to buy items with.
GetClasses()client
Returns the classes allowed to trade with the open salesman.
GetEntity()client
Returns the salesman entity the trade menu was opened for.
GetFactions()client
Returns the factions allowed to trade with the open salesman.
GetFlags()client
Returns the flags required to trade with the open salesman.
GetName()client
Returns the name of the open salesman.
GetPanel()client
Returns the salesman trade menu panel.
GetPriceScale()client
Returns the multiplier the open salesman applies to item costs when selling.
GetSells()client
Returns the items the open salesman sells.
GetStock()client
Returns the remaining stock of the open salesman.
GetText()client
Returns the responses of the open salesman.
IsSalesmenuOpen()client
Returns whether the salesman trade menu exists and is visible.

Methods

cw.salesmenu:BuyInShipments()

client gamemodes/catwork/plugins/salesmen/plugin/libraries/cl_salesmenu.lua:20

Returns whether the open salesman sells items in whole shipments (the item's batch size).

Returns

  • Boolean Whether items are sold in shipments

cw.salesmenu:GetBuyRate()

client gamemodes/catwork/plugins/salesmen/plugin/libraries/cl_salesmenu.lua:32

Returns the percentage of an item's cost the open salesman pays when buying it.

Returns

  • Number The buy rate, from 1 to 100

cw.salesmenu:GetBuys()

client gamemodes/catwork/plugins/salesmen/plugin/libraries/cl_salesmenu.lua:74

Returns the items the open salesman buys.

Returns

  • Map Item unique IDs mapped to a price override, or true to use the item's cost

cw.salesmenu:GetCash()

client gamemodes/catwork/plugins/salesmen/plugin/libraries/cl_salesmenu.lua:56

Returns the cash the open salesman has to buy items with.

Returns

  • Number The salesman's cash, -1 for unlimited

cw.salesmenu:GetClasses()

client gamemodes/catwork/plugins/salesmen/plugin/libraries/cl_salesmenu.lua:38

Returns the classes allowed to trade with the open salesman.

Returns

  • Map Class names mapped to true; empty for no restriction

cw.salesmenu:GetEntity()

client gamemodes/catwork/plugins/salesmen/plugin/libraries/cl_salesmenu.lua:68

Returns the salesman entity the trade menu was opened for.

Returns

cw.salesmenu:GetFactions()

client gamemodes/catwork/plugins/salesmen/plugin/libraries/cl_salesmenu.lua:44

Returns the factions allowed to trade with the open salesman.

Returns

  • Map Faction names mapped to true; empty for no restriction

cw.salesmenu:GetFlags()

client gamemodes/catwork/plugins/salesmen/plugin/libraries/cl_salesmenu.lua:98

Returns the flags required to trade with the open salesman.

Returns

  • String The flags

cw.salesmenu:GetName()

client gamemodes/catwork/plugins/salesmen/plugin/libraries/cl_salesmenu.lua:92

Returns the name of the open salesman.

Returns

  • String The salesman's name

cw.salesmenu:GetPanel()

client gamemodes/catwork/plugins/salesmen/plugin/libraries/cl_salesmenu.lua:86

Returns the salesman trade menu panel.

Returns

  • Panel The cwSalesmenu panel, or nil if it was never created

cw.salesmenu:GetPriceScale()

client gamemodes/catwork/plugins/salesmen/plugin/libraries/cl_salesmenu.lua:26

Returns the multiplier the open salesman applies to item costs when selling.

Returns

  • Number The price scale, 1 when unset

cw.salesmenu:GetSells()

client gamemodes/catwork/plugins/salesmen/plugin/libraries/cl_salesmenu.lua:80

Returns the items the open salesman sells.

Returns

  • Map Item unique IDs mapped to a price override, or true to use the item's cost

cw.salesmenu:GetStock()

client gamemodes/catwork/plugins/salesmen/plugin/libraries/cl_salesmenu.lua:50

Returns the remaining stock of the open salesman.

Returns

  • Map Item unique IDs mapped to the amount left; items without an entry are unlimited

cw.salesmenu:GetText()

client gamemodes/catwork/plugins/salesmen/plugin/libraries/cl_salesmenu.lua:62

Returns the responses of the open salesman.

Returns

  • Map Response names such as start or noStock mapped to Maps with text, sound and bHideName

cw.salesmenu:IsSalesmenuOpen()

client gamemodes/catwork/plugins/salesmen/plugin/libraries/cl_salesmenu.lua:10

Returns whether the salesman trade menu exists and is visible.

Returns

  • Boolean true when the menu is open, otherwise nil

Defined in