Hooks/Shared/canBuyShipment

From Official DarkRP Wiki
Jump to: navigation, search
Hook
Hook name canBuyShipment(Player ply, table shipmentTable)
Description:
Whether a player can buy a shipment.
Returns: boolean canBuy, boolean suppressMessage, string message, number price
Realm: NewerShared.png
BBCode Link: [b][url=http://wiki.darkrp.com/index.php?title=Hooks/Shared/canBuyShipment]canBuyShipment hook[/url][/b]

Parameters

  1. ply (Player)
  2. The player.

  3. shipmentTable (table)
  4. The table, as defined in the shipments file.

Return values

  1. canBuy (boolean)
  2. Whether it can be bought.

  3. suppressMessage (boolean)
  4. Suppress the notification message when it cannot be bought.

  5. message (string)
  6. A replacement for the message that shows if it cannot be bought.

  7. price (number)
  8. An optional override for the price.