Skip to main content

Introduction

This component provides a window for working with a Merchant

"Merchant Window UI"

Fields#

NameDescription
Player SourceDetermine if source is a Direct Reference or in the Tool Registry
Player KeyKey used to find source
Player ListUI showing player's inventory
Player CurrencyCurrency list for Player
Merchant SourceDetermine if source is a Direct Reference or in the Tool Registry
Merchant KeyKey used to find source
Merchant ListUI showing merchant's stock
Merchant CurrencyCurrency list for Merchant
LabelsList of labels and formats for displaying information
On Can BuyEvent raised when selected item can be bought by player
On Cannot BuyEvent raised when selected item cannot be bought by player
On Can SellEvent raised when selected item can be sold to player
On Cannot SellEvent raised when selected item cannot be sold to player
On Player ActiveEvent raised when player inventory is active
On Merchant ActiveEvent raised when merchant inventory is active
On Limited FundsEvent raised when merchant has limited funds
On Infinite FundsEvent raised when merchant has unlimited funds
IdID for this screen
Destroy On CloseDestroy instance when screen is closed
Allow DragAllow the window to be dragged
Non ModalSet the window as non-modal, allowing other windows to open as well
Allow Multiple InstanceAllow multiple instances of this window to be open at the same time
Open NavOpen navigation
Close NavClose navigation
Audio Pool ChannelName of the broadcaster channel to use with the audio ppol
Open SoundSound to play on open
Close SoundSound to play on close
On OpenEvent raised when screen is opened
On CloseEvent raised when screen is closed

Properties#

NameDescription
parametersParameters associated with the window
themeTheme used to open window

Methods#

NameDescription
BuyFromPlayerBuy an item from the player
BuySelectedFromPlayerBuy select item from the player
CanBuyFromPlayerGets if a certain count of an item can be bought from the player
CanSellToPlayerGets if a certain count of an item can be sold to the player
GetBuyPriceGet the price the merchant will pay to buy a certain number of an item from the player
GetSellPriceGet the price the merchant requires to sell a certain number of an item from the player
RestockRestock Merchant (keep existing)
RestockFreshRestock Merchant (keep existing)
SellToPlayerSell an item to the player
SellSelectedToPlayerSell selected item to the player
SetArgsSet the parameters for the window
SwapStateToggle between sell (player) and buy (merchant) modes
CloseClose the window