Studios
Small Resourceshouse-3.jpg

Commands & Exports

SoonSmall ResourcesQbox
PAGE 06 OF 06  ·  TROUBLESHOOTING → COMMANDS & EXPORTSdocs.glitchstudios.dev
Browse docs

Commands#

Command Who What
/carry Everyone Start or stop carrying a nearby player. The carrier runs a pickup progress bar first. /dropcarry puts them down, default key X, rebindable in the key settings.
/id Everyone Shows IDs of nearby players for a few seconds and tells those players that you checked. The name is player.command in qbx_showids/config.lua.
/modid mod or moderator ace Shows ID, name over heads, with no chat message. The name is mod.command.
/kidnapkick <id> [reason] group.admin Kicks a player with a short van scene. Name and group are in qbx_kickscene/config.json.
/kickscene [on or off] group.god Turns the kick scene on or off, or toggles it when no argument is given.
/staticemitters menuAce (default admin) Opens the menu to switch map sound emitters off and shows nearby emitters.
/editor, /record, /clip, /saveclip, /delclip Everyone Rockstar Editor clip menu, recording, replay buffer and clip handling.

Key bindings

All use ox_lib or FiveM key mappings, so players can rebind them.

Binding Default key Module
Tackle E (on release) qbx_tackle
Reload taser R (reloadKey) qbx_taser
Crouch LCONTROL qbx_crouch
Cruise control Y qbx_cruise
Push vehicle E and LSHIFT together qbx_vehiclepush
Zoom (hold) Middle mouse button zoom
Drop carried player X carry

Server exports#

Call them as exports['glitch-smallresources']:Name(...).

Export Returns What it does
AllowBlacklisted(model, source, ms) boolean false when the model is blacklisted and the player lacks the bypass ace. Otherwise true, and a blacklisted model is let through for ms milliseconds (default 10000).
ResetAFK(source) nothing Resets the player's AFK timer.
GetCarried(source) server id or nil The player this carrier is carrying.
StopCarry(source) nothing Ends the carry for that player and their partner.
KickWithScene(target, reason, kind) boolean Kicks with the scene when enabled. Returns true when the scene is used. kind is 'kick' or 'ban'.
IsKickSceneEnabled() boolean Whether the scene is currently on.
SetHunger(source, amount), AddHunger(source, amount) nothing Set or add to hunger. Lower-case setHunger and addHunger also exist but are deprecated.
SetThirst(source, amount), AddThirst(source, amount) nothing Set or add to thirst. Lower-case versions are deprecated.

Client exports#

Export Returns What it does
FlipVehicle(vehicle, flipTest) nothing Flips the given vehicle, or the closest one within maxDistance. flipVehicle is the same function under the older spelling.
RightVehicle(vehicle) boolean Stands a vehicle upright after taking control of it.
KnockOut() boolean Knocks the local player out. false when it cannot happen right now.
WakeUp(full) nothing Ends the knocked out timer early. Pass true to skip the groggy phase too.
IsKnockedOut() boolean Whether the local player is knocked out.
SetCrosshairEnabled(state) nothing Turns the custom crosshair on or off.
GetTaserCartridges() loaded, bays Cartridges currently loaded and the number of bays.
AddDisableHudComponents(ids), RemoveDisableHudComponents(ids), GetDisableHudComponents() table for the getter Manage hidden HUD components. The add and remove calls accept a number or an array.
AddDisableControls(ids), RemoveDisableControls(ids), GetDisableControls() table for the getter Manage disabled controls.
SetDisplayAmmo(bool), GetDisplayAmmo() boolean for the getter Show or hide the ammo display.
blockZoom(bool) nothing Stops the hold-to-zoom camera while true.

The qbx_consumables module also exports the client effects TrevorEffect, MethBagEffect, EcstasyEffect, AlienEffect, CrackBaggyEffect and CokeBaggyEffect. Each HUD export also has a deprecated lower-case form.

Events#

Event Side What it does
glitch-notify Client Shows an ox_lib notification from { title, description, type, duration }. Needs hooks.notifyEvents.
glitch-textui Client Shows ox_lib text UI from { text, position, icon, style }. Needs hooks.notifyEvents.
glitch-textui:hide Client Hides the text UI.
glitch-carry:client:toggle Client Same as /carry.
consumables:server:setHunger, consumables:server:addHunger, consumables:server:setThirst, consumables:server:addThirst Server Set or add to the calling player's hunger or thirst. Used by the ox_inventory QB bridge.
lockpicks:UseLockpick Fired by this resource Fired with false for a lockpick and true for an advancedlockpick when hooks.lockpickItems is on.

The remaining events (glitch-carry:server:*, qbx_taser:server:fired, tackle:server:*, qbx_vehiclepush:server:push, qbx_kickscene:*) are internal to the modules and validated on the server. Do not trigger them from other resources.

Callbacks#

Callback Side What it does
glitch-carry:server:begin Server Arms a carry pickup.
qbx_taser:server:reload Server Loads cartridges from the player's inventory. Returns the new count, or false.
consumables:server:usedItem Server Removes one consumable item and returns the result.
qbx_staticemitters:server:IsPlayerAceAllowed Server Whether the player holds the menuAce.
consumables:client:Eat, consumables:client:Drink, consumables:client:DrinkAlcohol Client Play the animation and progress bar for a consumable.