Functions
The Functions
module exposes the following case-sensitive functions with their usage, parameters, and return values.
-
IsLocalPlayerInOwnVehicle()Parameters: None
Returns:boolean
Returnstrue
if the local player is currently in their own vehicle; otherwisefalse
. -
GetCurrentLocalPlayerCar()Parameters: None
Returns:Model | nil
Returns the vehicle model the local player is currently using ornil
if none. -
IsLocalPlayerAlive()Parameters: None
Returns:boolean
Returnstrue
if the local player is alive, otherwisefalse
. -
GetClosestVehicle()Parameters: None
Returns:Model | nil
Returns the closest vehicle model to the local player ornil
if none found. -
GetRandomVehicle()Parameters: None
Returns:Model | nil
Returns a random vehicle model ornil
. -
IsGodModeEnabled()Parameters: None
Returns:boolean
Returnstrue
if god mode is enabled, otherwisefalse
. -
IsPlayerWanted(Player)Parameters:
Name Type Description Player Player
The player instance to check if wanted. Example: game.Players.LocalPlayer
boolean
Returnstrue
if the specified player is wanted, otherwisefalse
.
-
ToolIsAnGun(Tool)Parameters:
Name Type Description Tool Instance
The tool instance to check boolean
Returnstrue
if the tool is recognized as a gun, otherwisefalse
.
-
TeleportTo(CFrame | Vector3)Parameters:
Name Type Description position CFrame | Vector3
Target location to teleport the player to
Teleports the local player to the specified location. This function yields until teleportation completes.
-
IsPRCMod(Player)Parameters:
Name Type Description Player Player
The player instance to check for PRC mod status Instance | nil
Returns an Instance if the player is a PRC mod, ornil
otherwise.
-
equipGun()Parameters: None
Yields: Yes
Equips the gun to the local player. This function yields until equipped. -
buyGear(GearName: string, WhenAutorob: boolean, Timeout: number)Parameters:
Name Type Description GearName string
Name of the gear to buy WhenAutorob boolean
If true
, buy during autorobTimeout number
Timeout in seconds before canceling
Buys specified gear with optional autorob and timeout behavior. -
buyGun(GunName: string, WhenAutorob: boolean, Timeout: number)Parameters:
Name Type Description GunName string
Name of the gun to buy WhenAutorob boolean
If true
, buy during autorobTimeout number
Timeout in seconds before canceling
Buys specified gun with optional autorob and timeout behavior.
Connections
The Connections
module exposes these events. Listen with :Connect(function(Info) ... end)
.
-
OnCMDUsed.EventDescription: Fires when a command is used.
Event Args:Name Type Description Command string
The command used UsedOn Player
The player the command was used on
Example:Connections.OnCMDUsed.Event:Connect(function(Info) print("Used:", Info.Command, "On player:", Info.UsedOn) end)
-
OnPRCStaffJoin.EventDescription: Fires when a PRC staff joins.
Event Args: None
Example:Connections.OnPRCStaffJoin.Event:Connect(function(Info) game:GetService("Players").LocalPlayer:Kick("PRC Mod joined you") end)
-
OnLocalPlayerChatted.EventDescription: Fires when local player chats.
Event Args:Name Type Description Message string
The chat message
Example:Connections.OnLocalPlayerChatted.Event:Connect(function(Info) print("LocalPlayer said:", Info.Message) end)
-
OnLocalPlayerViewed.EventDescription: Fires when another player views the local player.
Event Args:Name Type Description PlayerName string
Name of the player viewing
Example:Connections.OnLocalPlayerViewed.Event:Connect(function(Info) print(Info.PlayerName, "Is viewing you!") end)
-
OnStaffUnview.EventDescription: Fires when a player stops viewing the local player.
Event Args:Name Type Description PlayerName string
Name of the player who stopped viewing
Example:Connections.OnStaffUnview.Event:Connect(function(Info) print(Info.PlayerName, "Stopped viewing u!") end)
Tabs
The UI contains the following tabs:
-
MainDescription: Primary tab with core controls.
Example Buttons:
Tabs.Main:Button({ Title = "Buy RFID", Desc = "I buy RFID", Callback = function() Functions:BuyGear("RFID Disruptor", false, 5) -- GearToBuy, WhenAutorob, Timeout end, })
Tabs.Main:Button({ Title = "Teleport somewhere", Desc = "I teleport you somewhere!!!", Locked = false, Callback = function() Functions:TeleportTo(CFrame.new(-749, 85, 713)) end, })
-
LocalPlayer
Controls and info relevant to the local player.
-
Players
Player-specific controls and data.
-
Trolling
Fun and trolling features.
-
Visuals
Visual modifications and overlays.
-
VehicleMods
Vehicle modification features.
-
GunMods
Gun modification features.
-
Aimbot
Aimbot and targeting features.
-
Robberies
Robbery automation and controls.
-
Automation
Automation of repetitive tasks.
-
Teleports
Teleportation features and controls.
-
Settings
Configuration and settings options.
Example Usage
Here are some code examples showing how to use the API:
Function calls
print(Functions:IsPlayerWanted(game.Players.LocalPlayer))
print(Functions:ToolIsAnGun(Instance.new("Tool")))
if Functions:GetRandomVehicle() then
print("Found a random vehicle")
end
UI Button Example
Tabs.Main:Button({
Title = "Buy RFID",
Desc = "I buy RFID",
Callback = function()
Functions:BuyGear("RFID Disruptor", false, 5) -- GearToBuy, WhenAutorob, Timeout
end,
})
Tabs.Main:Button({
Title = "Teleport somewhere",
Desc = "I teleport you somewhere!!!",
Locked = false,
Callback = function()
Functions:TeleportTo(CFrame.new(-749, 85, 713)) -- CFrame or a Position (Vector3)
end,
})
Connections Example
Connections.OnCMDUsed.Event:Connect(function(Info)
print("Used:", Info.Command, "On player:", Info.UsedOn)
end)
Connections.OnPRCStaffJoin.Event:Connect(function(Info)
game:GetService("Players").LocalPlayer:Kick("PRC Mod joined you")
end)
Base Example
repeat task.wait() until _G.WindUI and _G.Functions and _G.Tabs
local WindUI = _G.WindUI
local Tabs = _G.Tabs
local function WindUINotify(title: string, content: string, duration: number)
WindUI:Notify({
Title = title,
Content = content,
Duration = duration,
})
end
Tabs.Automation:Button({
Title = "BUTTON",
Desc = "Completes a BUTTON TASSK",
Locked = false,
Callback = function()
-- do shit here boom
WindUINotify('abc','def',5)
end,
})