PivityGmodStore

Hooks

Here is a list of all the hooks and what they do

Blackjack

pCasinoCanBlackjackBet

Description:

Used to block betting on a blackjack table

Arguments:

  1. Entity | Player who is trying to place the bet
  2. Entity | The table the bet is being placed on
  3. String | The type of bet. This will be one of the following: doubledown, split, hit or bet

Return:

  1. Boolean | If false, this will block the user from placing the bet
  2. String OR nil | The chat message to display to the user


pCasinoOnBlackjackBet

Description:

Called when a player makes a bet on a blackjack table.

Arguments:

  1. Entity | Player who placed the bet
  2. Entity | The table the bet was placed on
  3. Integer | The amount they bet


pCasinoOnBlackjackPayout

Description:

Called when a player receives a payout from a blackjack table.

Arguments:

  1. Entity | Player who receives the payout
  2. Entity | The table the payout comes from
  3. Integer | The amount they receive


pCasinoOnBlackjackLoss

Description:

Called when a player loses at a blackjack table.

Arguments:

  1. Entity | Player who lost the bet
  2. Entity | The table the bet was placed on
  3. Integer | The amount they originally bet


Mystery Wheel

pCasinoCanMysteryWheelSpin

Description:

Used to block spinning a Mystery Wheel

Arguments:

  1. Entity | Player who is trying to spin
  2. Entity | The wheel the spin is being done on
  3. Boolean | If the spin is a free spin

Return:

  1. Boolean | If false, this will block the user from spinning the wheel
  2. String OR nil | The chat message to display to the user


pCasinoOnMysteryWheelBet

Description:

Called when a player spins the mystery wheel.

Arguments:

  1. Entity | Player who placed the bet
  2. Entity | The wheel the bet was placed on
  3. Integer | The amount they bet


Roulette Table

pCasinoCanRouletteBet

Description:

Used to block betting on a roulette table.

Arguments:

  1. Entity | Player who is trying to bet
  2. Entity | The table the bet is being placed on

Return:

  1. Boolean | If false, this will block the user from betting on the table
  2. String OR nil | The chat message to display to the user


pCasinoOnRouletteBet

Description:

Called when a player places a bet on a roulette table.

Arguments:

  1. Entity | Player who placed the bet
  2. Entity | The table the bet was placed on
  3. Integer | The amount they bet


pCasinoOnRoulettePayout

Description:

Called when a player receives a payout from a roulette table.

Arguments:

  1. Entity | Player who receives the payout
  2. Entity | The table the payout comes from
  3. Integer | The amount they receive


pCasinoOnRouletteLoss

Description:

Called when a player loses at a roulette table.

Arguments:

  1. Entity | Player who lost the bet
  2. Entity | The table the bet was placed on
  3. Integer | The amount they originally bet


Basic Slot Machine

pCasinoCanBasicSlotMachineBet

Description:

Used to block betting on a basic slot machine

Arguments:

  1. Entity | Player who is trying to bet
  2. Entity | The machine the bet is being placed on

Return:

  1. Boolean | If false, this will block the user from betting on the machine
  2. String OR nil | The chat message to display to the user


pCasinoOnBasicSlotMachineBet

Description:

Called when a player places a bet on a basic slot machine.

Arguments:

  1. Entity | Player who placed the bet
  2. Entity | The machine the bet was placed on
  3. Integer | The amount they bet


pCasinoOnBasicSlotMachinePayout

Description:

Called when a player receives a payout from a basic slot machine.

Arguments:

  1. Entity | Player who receives the payout
  2. Entity | The machine the payout comes from
  3. Integer | The amount they receive


pCasinoOnBasicSlotMachineJackpot

Description:

Called when a player hits the jackpot on a basic slot machine.

Arguments:

  1. Entity | Player who receives the jackpot
  2. Entity | The machine the jackpot comes from
  3. Integer | The amount they receive


pCasinoOnBasicSlotMachineLoss

Description:

Called when a player loses on a basic slot machine.

Arguments:

  1. Entity | Player who lost the bet
  2. Entity | The machine the bet was placed on
  3. Integer | The amount they originally bet


Wheel Slot Machine

pCasinoCanWheelSlotMachineBet

Description:

Used to block betting on a wheel slot machine

Arguments:

  1. Entity | Player who is trying to bet
  2. Entity | The machine the bet is being placed on

Return:

  1. Boolean | If false, this will block the user from betting on the machine
  2. String OR nil | The chat message to display to the user


pCasinoOnWheelSlotMachineBet

Description:

Called when a player places a bet on a wheel slot machine.

Arguments:

  1. Entity | Player who placed the bet
  2. Entity | The machine the bet was placed on
  3. Integer | The amount they bet


pCasinoOnWheelSlotMachinePayout

Description:

Called when a player receives a payout from a wheel slot machine.

Arguments:

  1. Entity | Player who receives the payout
  2. Entity | The machine the payout comes from
  3. Integer | The amount they receive


pCasinoOnWheelSlotMachineLoss

Description:

Called when a player loses on a wheel slot machine.

Arguments:

  1. Entity | Player who lost the bet
  2. Entity | The machine the bet was placed on
  3. Integer | The amount they originally bet


Poker

pCasinoCanPokerJoin

Description:

Called when a player tries to join the table. Return false to block joining

Arguments:

  1. Entity | Player who is joining
  2. Entity | The table
  3. Integer | The specific seat (1-6)


pCasinoOnPokerJoin

Description:

Called when a player has joined the table

Arguments:

  1. Entity | Player who is joining
  2. Entity | The table
  3. Integer | The specific seat (1-6)


pCasinoOnPokerLeave

Description:

Called when a player leaves a table

Arguments:

  1. Entity | Player who is joining
  2. Entity | The table
  3. Integer | The specific seat (1-6)
  4. String | Why the player left


pCasinoOnPokerAction

Description:

Called when a player does a poker action

Arguments:

  1. Entity | Player who is joining
  2. Entity | The table
  3. String | The action (fold, call, raise, allin, etc)
  4. Integer | The chips committed with that action


pCasinoCanPokerBet

Description:

Called when a player wants to place a bet. Return false to block the bet

Arguments:

  1. Entity | Player who is joining
  2. Entity | The table
  3. Integer | The bet amount


pCasinoOnPokerBet

Description:

Called when a player has placed a bet

Arguments:

  1. Entity | Player who is joining
  2. Entity | The table
  3. Integer | The bet amount


pCasinoOnPokerPayout

Description:

Called when a player is paid out winnings

Arguments:

  1. Entity | Player who is joining
  2. Entity | The table
  3. Integer | Their winning amount, after rake is deducted


pCasinoOnPokerLoss

Description:

Called when a player loses a hand

Arguments:

  1. Entity | Player who is joining
  2. Entity | The table
  3. Integer | The total amount of chips put in by that player


pCasinoOnPokerRake

Description:

Called when the rake is taken from the payout. Ideal for giving Casino Managers their cut

Arguments:

  1. Entity | The table
  2. Integer | The rake amount taken


Can't find what you're looking for?

Contact support