Skip to content

Hooks

Module-specific events raised by the Slots module.


SlotMachineUse

Purpose

Runs when a player interacts with the slot machine before paying.

Parameters

  • machine (Entity): The slot machine entity.

  • client (Player): The player who used the machine.

Realm

Server

Returns

nilReturn value is ignored.

Example

hook.Add("SlotMachineUse", "CheckVIP", function(machine, client)
    if not client:isVIP() then
        return false
    end
end)

SlotMachineStart

Purpose

Fired once the player has paid and the wheels begin to spin.

Parameters

  • machine (Entity): The slot machine entity.

  • client (Player): Player who started the spin.

Realm

Server

Returns

nilReturn value is ignored.

Example

hook.Add("SlotMachineStart", "AnnounceSpin", function(machine, client)
    client:EmitSound("slots_spin.wav")
end)

SlotMachinePayout

Purpose

Called when the player wins money from the machine.

Parameters

  • machine (Entity): The slot machine entity.

  • client (Player): Player who won.

  • amount (number): Amount of money awarded.

Realm

Server

Returns

nilReturn value is ignored.

Example

hook.Add("SlotMachinePayout", "LogWin", function(machine, client, amount)
    print(client:Name() .. " won " .. amount .. "T")
end)

SlotMachineEnd

Purpose

Runs after the spin is finished regardless of the result.

Parameters

  • machine (Entity): The slot machine entity.

  • client (Player): Player who played.

  • amount (number): Money paid out (0 if nothing).

Realm

Server

Returns

nilReturn value is ignored.

Example

hook.Add("SlotMachineEnd", "ReadyAgain", function(machine, client)
    machine.IsPlaying = true
end)