Potassium API
  • Environment
    • Cache
    • Closures
    • Console
    • Crypt
    • Debug
    • Drawing
    • File System
    • Input
    • Instance
    • Metatable
    • Miscellaneous
    • Scripts
    • Web Sockets
    • Actor
Powered by GitBook
On this page
  • fireclickdetector
  • firetouchinterest
  • isnetworkowner
  • getcallbackvalue
  • fireproximityprompt
  • getconnections
  • getconnection
  • firesignal
  • getcustomasset
  • gethiddenproperty
  • setsimulationradius
  • gethui
  • getinstances
  • getnilinstances
  • isscriptable
  • sethiddenproperty
  • setrbxclipboard
  • setscriptable
  • getrendersteppedlist
  • replicatesignal
  1. Environment

Instance

fireclickdetector

<nil> fireclickdetector(<ClickDetector> object, <number?> distance)

Dispatches a click or hover event to the given ClickDetector. When absent, distance defaults to zero.

local clickDetector = workspace.Door.Button.ClickDetector
fireclickdetector(clickDetector, 10 + math.random())

firetouchinterest

<nil> firetouchinterest(<Instance> instance, <Instance> touchingPart, <bool> isTouching)

Simulates a touch event between two parts.

local rootPart = game.Players.LocalPlayer.Character.HumanoidRootPart
firetouchinterest(workspace.TouchPart, rootPart, true)
firetouchinterest(workspace.TouchPart, rootPart, false)

isnetworkowner

<bool> isnetworkowner(<Instance> part)

Returns true if the Part is owned by the player.


getcallbackvalue

<function?> getcallbackvalue(<Instance> object, <string> property)

Returns the function assigned to a callback property of object, which cannot be indexed normally.


fireproximityprompt

<nil> fireproximityprompt(<ProximityPrompt> prompt)

Fires the trigger of prompt.


getconnections

<table<ConnectionObject>> getconnections(<RBXScriptSignal> signal)

Creates a list of Connection objects for the functions connected to signal.

Field
Type
Description

Enabled

boolean

Whether the connection can receive events.

ForeignState

boolean

Whether the function was connected by a foreign Luau state (i.e. CoreScripts).

LuaConnection

boolean

Whether the connection was created in Luau code.

Function

function?

The function bound to this connection. Nil when ForeignState is true.

Thread

thread?

The thread that created the connection. Nil when ForeignState is true.

Method
Description

Fire(...: any): ()

Fires this connection with the provided arguments.

Defer(...: any): ()

Disconnect(): ()

Disconnects the connection.

Disable(): ()

Prevents the connection from firing.

Enable(): ()

Allows the connection to fire if it was previously disabled.


getconnection

<table<ConnectionObject>> getconnection(<RBXScriptSignal> signal, <number> index)

Returns a Connection object for index .


firesignal

<nil> firesignal(<RBXScriptSignal> signal, ...)

Fires all Lua connections of signal .


getcustomasset

<string> getcustomasset(<string> path)

Returns a rbxasset:// content id for the asset located at path, allowing you to use unmoderated assets. Internally, files are copied to the game's content directory.


gethiddenproperty

<any, boolean> gethiddenproperty(<Instance> object, <string> property)

Returns the value of a hidden property of object, which cannot be indexed normally.

If the property is hidden, the second return value will be true. Otherwise, it will be false.

local fire = Instance.new("Fire")
print(gethiddenproperty(fire, "size_xml")) --> 5, true
print(gethiddenproperty(fire, "Size")) --> 5, false

setsimulationradius

<nil> setsimulationradius(<number> simulationRadius, <number?> maxSimulationRadius)  

Sets the player's simulationRadius. If maxSimulationRadius is specified, it will set that as well.


gethui

<Folder> gethui()

Returns a hidden GUI container. Should be used as an alternative to CoreGui and PlayerGui.

GUI objects parented to this container will be protected from common detection methods.


getinstances

<table<Instance>> getinstances()

Returns a list of every Instance referenced on the client.


getnilinstances

<table<Instance>> getnilinstances()

Like getinstances, but only includes Instances that are not descendants of a service provider.


isscriptable

<boolean> isscriptable(<Instance> object, <string> property)

Returns whether the given property is scriptable (does not have the notscriptable tag).

If true, the property is scriptable and can be indexed normally. If nil, the property does not exist.


sethiddenproperty

<boolean> sethiddenproperty(<Instance> object, <string> property, <any> value)

Sets the value of a hidden property of object, which cannot be set normally. Returns whether the property was hidden.

local fire = Instance.new("Fire")
print(sethiddenproperty(fire, "Size", 5)) --> false (not hidden)
print(sethiddenproperty(fire, "size_xml", 15)) --> true (hidden)
print(gethiddenproperty(fire, "size_xml")) --> 15, true (hidden)

setrbxclipboard

<boolean> setrbxclipboard(<string> data)

Sets the Studio client's clipboard to the given rbxm or rbxmx model data. This allows data from the game to be copied into a Studio client.

local data = readfile("model.rbxm")
setrbxclipboard(data) -- Can be pasted into Studio

setscriptable

<boolean> setscriptable(<Instance> object, <string> property, <boolean> value)

Set whether the given property is scriptable. Returns whether the property was scriptable prior to changing it.


getrendersteppedlist

<table> getrendersteppedlist()

Returns all callbacks bound with RunService.BindToRenderStep .


replicatesignal

<nil> replicatesignal(<RBXScriptSignal> signal, ...)

Replicates signal on the server.

If signal has one or multiple arguments, they must be provided in the call.

replicatesignal(game.Players.LocalPlayer.Kill) --> Kills you

local sword = game.Players.LocalPlayer.Character.ClassicSword
replicatesignal(sword.Activated) --> Swings the sword

PreviousInputNextMetatable

Last updated 2 months ago

an event to connection with the provided arguments.

Defers