cw.salesman classclient

Part of Salesmen

Defines the client-side cw.salesman library, which holds the state of the salesman being created or edited in the cwSalesman editor.

The Cable receivers and the editor write the fields straight into the library table; its getters expose the name, model, sells and buys lists, stock, cash, price scale, buy rate, responses and the factions, classes and flags allowed to trade.

Summary

Methods

BuyInShipments()client
Returns whether the salesman being edited sells items in whole shipments (the item's batch size).
GetBuyRate()client
Returns the percentage of an item's cost the salesman being edited pays when buying it.
GetBuys()client
Returns the items the salesman being edited buys.
GetCash()client
Returns the cash the salesman being edited has to buy items with.
GetClasses()client
Returns the classes allowed to trade with the salesman being edited.
GetFactions()client
Returns the factions allowed to trade with the salesman being edited.
GetFlags()client
Returns the flags required to trade with the salesman being edited.
GetItems()client
Returns every non-base item that can be added to the salesman being edited.
GetModel()client
Returns the model of the salesman being edited.
GetName()client
Returns the name of the salesman being edited.
GetPanel()client
Returns the salesman editor panel.
GetPriceScale()client
Returns the multiplier applied to item costs when the salesman being edited sells.
GetSells()client
Returns the items the salesman being edited sells.
GetShowChatBubble()client
Returns whether the salesman being edited shows a chat bubble above its head.
GetStock()client
Returns the starting stock of each item the salesman being edited sells.
GetText()client
Returns the responses of the salesman being edited.
IsSalesmanOpen()client
Returns whether the salesman editor panel exists and is visible.

Methods

cw.salesman:BuyInShipments()

client gamemodes/catwork/plugins/salesmen/plugin/libraries/cl_salesman.lua:22

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

Returns

  • Boolean Whether items are sold in shipments

cw.salesman:GetBuyRate()

client gamemodes/catwork/plugins/salesmen/plugin/libraries/cl_salesman.lua:52

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

Returns

  • Number The buy rate, from 1 to 100

cw.salesman:GetBuys()

client gamemodes/catwork/plugins/salesmen/plugin/libraries/cl_salesman.lua:85

Returns the items the salesman being edited buys.

Returns

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

cw.salesman:GetCash()

client gamemodes/catwork/plugins/salesmen/plugin/libraries/cl_salesman.lua:46

Returns the cash the salesman being edited has to buy items with.

Returns

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

cw.salesman:GetClasses()

client gamemodes/catwork/plugins/salesmen/plugin/libraries/cl_salesman.lua:58

Returns the classes allowed to trade with the salesman being edited.

Returns

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

cw.salesman:GetFactions()

client gamemodes/catwork/plugins/salesmen/plugin/libraries/cl_salesman.lua:64

Returns the factions allowed to trade with the salesman being edited.

Returns

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

cw.salesman:GetFlags()

client gamemodes/catwork/plugins/salesmen/plugin/libraries/cl_salesman.lua:115

Returns the flags required to trade with the salesman being edited.

Returns

  • String The flags; a - in the string refuses players without them

cw.salesman:GetItems()

client gamemodes/catwork/plugins/salesmen/plugin/libraries/cl_salesman.lua:91

Returns every non-base item that can be added to the salesman being edited.

Returns

  • Map<Item> Item tables keyed by unique ID

cw.salesman:GetModel()

client gamemodes/catwork/plugins/salesmen/plugin/libraries/cl_salesman.lua:103

Returns the model of the salesman being edited.

Returns

  • String The model path

cw.salesman:GetName()

client gamemodes/catwork/plugins/salesmen/plugin/libraries/cl_salesman.lua:109

Returns the name of the salesman being edited.

Returns

  • String The salesman's name

cw.salesman:GetPanel()

client gamemodes/catwork/plugins/salesmen/plugin/libraries/cl_salesman.lua:97

Returns the salesman editor panel.

Returns

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

cw.salesman:GetPriceScale()

client gamemodes/catwork/plugins/salesmen/plugin/libraries/cl_salesman.lua:28

Returns the multiplier applied to item costs when the salesman being edited sells.

Returns

  • Number The price scale, 1 when unset

cw.salesman:GetSells()

client gamemodes/catwork/plugins/salesmen/plugin/libraries/cl_salesman.lua:79

Returns the items the salesman being edited sells.

Returns

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

cw.salesman:GetShowChatBubble()

client gamemodes/catwork/plugins/salesmen/plugin/libraries/cl_salesman.lua:34

Returns whether the salesman being edited shows a chat bubble above its head.

Returns

  • Boolean Whether the chat bubble is shown

cw.salesman:GetStock()

client gamemodes/catwork/plugins/salesmen/plugin/libraries/cl_salesman.lua:40

Returns the starting stock of each item the salesman being edited sells.

Returns

  • Number Stock per item, -1 for unlimited

cw.salesman:GetText()

client gamemodes/catwork/plugins/salesmen/plugin/libraries/cl_salesman.lua:73

Returns the responses of the salesman being edited.

The keys are start, noSale, noStock, needMore, cannotAfford and doneBusiness; each value is a Map with text, sound and bHideName.

Returns

  • Map The salesman's responses

cw.salesman:IsSalesmanOpen()

client gamemodes/catwork/plugins/salesmen/plugin/libraries/cl_salesman.lua:12

Returns whether the salesman editor panel exists and is visible.

Returns

  • Boolean true when the editor is open, otherwise nil

Defined in