# Table of Contents

- [Actor | MyCompany Docs](#actor-mycompany-docs)
- [Cache | MyCompany Docs](#cache-mycompany-docs)
- [Console | MyCompany Docs](#console-mycompany-docs)
- [Debug | MyCompany Docs](#debug-mycompany-docs)
- [Drawing | MyCompany Docs](#drawing-mycompany-docs)
- [File System | MyCompany Docs](#file-system-mycompany-docs)
- [Input | MyCompany Docs](#input-mycompany-docs)
- [Metatable | MyCompany Docs](#metatable-mycompany-docs)
- [Instance | MyCompany Docs](#instance-mycompany-docs)
- [RakNet | MyCompany Docs](#raknet-mycompany-docs)
- [Web Sockets | MyCompany Docs](#web-sockets-mycompany-docs)
- [Crypt | MyCompany Docs](#crypt-mycompany-docs)
- [Closures | MyCompany Docs](#closures-mycompany-docs)
- [Scripts | MyCompany Docs](#scripts-mycompany-docs)
- [Miscellaneous | MyCompany Docs](#miscellaneous-mycompany-docs)
- [oth | MyCompany Docs](#oth-mycompany-docs)
- [Regex | MyCompany Docs](#regex-mycompany-docs)

---

# Actor | MyCompany Docs

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs#create_comm_channel)

create\_comm\_channel


---------------------------------------------------------------------------------------------------------

Copy

    <number, BindableEvent> create_comm_channel()

Returns the channel and the associated ID.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs#get_comm_channel)

get\_comm\_channel


---------------------------------------------------------------------------------------------------

Copy

    <BindableEvent> get_comm_channel(<number> id)

Returns the communication channel if it exists.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs#run_on_actor)

run\_on\_actor


-------------------------------------------------------------------------------------------

Copy

    <nil> run_on_actor(<Actor> actor, <string> script, ...)

Runs a script on an actor thread.

Copy

    run_on_actor(getactors()[1], [[\\
        print("Hello, world!")\\
    ]])

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs#getactors)

getactors


-----------------------------------------------------------------------------------

Copy

    <table<Actor>> getactors()

Returns a table of all actors that exist within the game.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs#is_parallel)

is\_parallel


----------------------------------------------------------------------------------------

Returns if the thread is running on an actor.

**Aliases:** `isparallel`

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs#run_on_thread)

run\_on\_thread


---------------------------------------------------------------------------------------------

Runs a script on a specified thread, actor threads only.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs#getactorthreads)

getactorthreads


-----------------------------------------------------------------------------------------------

Returns all threads that belong to actors in a table.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs#getdeletedactors)

getdeletedactors


-------------------------------------------------------------------------------------------------

Returns a table of all actors that have been deleted from the game.

[NextCachechevron-right](https://mycompany-185.gitbook.io/mycompany-docs/cache)

Was this helpful?

*   [create\_comm\_channel](https://mycompany-185.gitbook.io/mycompany-docs#create_comm_channel)
    
*   [get\_comm\_channel](https://mycompany-185.gitbook.io/mycompany-docs#get_comm_channel)
    
*   [run\_on\_actor](https://mycompany-185.gitbook.io/mycompany-docs#run_on_actor)
    
*   [getactors](https://mycompany-185.gitbook.io/mycompany-docs#getactors)
    
*   [is\_parallel](https://mycompany-185.gitbook.io/mycompany-docs#is_parallel)
    
*   [run\_on\_thread](https://mycompany-185.gitbook.io/mycompany-docs#run_on_thread)
    
*   [getactorthreads](https://mycompany-185.gitbook.io/mycompany-docs#getactorthreads)
    
*   [getdeletedactors](https://mycompany-185.gitbook.io/mycompany-docs#getdeletedactors)
    

Was this helpful?

Copy

    <boolean> is_parallel()

Copy

    <nil> run_on_thread(<thread> thread, <string> script, ...)

Copy

    run_on_thread(getactorthreads()[1], [[\\
        print("Hello, world!")\\
    ]])

Copy

    <table<thread>> getactorthreads()

Copy

    <table> getdeletedactors()

---

# Cache | MyCompany Docs

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/cache#cache.invalidate)

cache.invalidate


-------------------------------------------------------------------------------------------------------

Copy

    <nil> cache.invalidate(<Instance> object)

Deletes `object` from the Instance cache. Effectively invalidates `object` as a reference to the underlying Instance.

* * *

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/cache#cache.iscached)

cache.iscached


---------------------------------------------------------------------------------------------------

Copy

    <boolean> cache.iscached(<Instance> object)

Checks whether `object` exists in the Instance cache.

* * *

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/cache#cache.replace)

cache.replace


-------------------------------------------------------------------------------------------------

Copy

    <nil> cache.replace(<Instance> object, <Instance> newobject)

Replaces `object` in the Instance cache with `newObject`.

* * *

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/cache#cloneref)

cloneref


---------------------------------------------------------------------------------------

Copy

    <Instance> cloneref(<Instance> object)

Returns a copy of the Instance reference to `object`. This is useful for managing an Instance without directly referencing it.

**Aliases:** `clonereference`

* * *

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/cache#compareinstances)

compareinstances


-------------------------------------------------------------------------------------------------------

Returns whether objects `a` and `b` both reference the same Instance.

[PreviousActorchevron-left](https://mycompany-185.gitbook.io/mycompany-docs)
[NextConsolechevron-right](https://mycompany-185.gitbook.io/mycompany-docs/console)

Was this helpful?

*   [cache.invalidate](https://mycompany-185.gitbook.io/mycompany-docs/cache#cache.invalidate)
    
*   [cache.iscached](https://mycompany-185.gitbook.io/mycompany-docs/cache#cache.iscached)
    
*   [cache.replace](https://mycompany-185.gitbook.io/mycompany-docs/cache#cache.replace)
    
*   [cloneref](https://mycompany-185.gitbook.io/mycompany-docs/cache#cloneref)
    
*   [compareinstances](https://mycompany-185.gitbook.io/mycompany-docs/cache#compareinstances)
    

Was this helpful?

Copy

    <boolean> compareinstances(<Instance> a, <Instance> b)

---

# Console | MyCompany Docs

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/console#rconsoleclear)

rconsoleclear


---------------------------------------------------------------------------------------------------

Copy

    <nil> rconsoleclear()

Clears the output of the console window.

**Aliases:** `consoleclear`

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/console#rconsolecreate)

rconsolecreate


-----------------------------------------------------------------------------------------------------

Copy

    <nil> rconsolecreate()

Opens the console window. Text previously output to the console will not be cleared.

**Aliases:** `consolecreate`

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/console#rconsoledestroy)

rconsoledestroy


-------------------------------------------------------------------------------------------------------

Copy

    <nil> rconsoledestroy()

Closes and destroys the console window.

**Aliases:** `consoledestroy`

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/console#rconsoleinput)

rconsoleinput


---------------------------------------------------------------------------------------------------

Copy

    <string> rconsoleinput()

Waits for the user to input text into the console window. Returns the result.

**Aliases:** `consoleinput`

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/console#rconsoleprint)

rconsoleprint


---------------------------------------------------------------------------------------------------

Prints `text` to the console window. Does not clear existing text or create a new line.

**Aliases:** `consoleprint`

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/console#rconsolewarn)

rconsolewarn


-------------------------------------------------------------------------------------------------

Prints `text` as a warning to the console window. Does not clear existing text or create a new line.

**Aliases:** `consolewarn`

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/console#rconsoleerror)

rconsoleerror


---------------------------------------------------------------------------------------------------

Prints `text` as an error to the console window. Does not clear existing text or create a new line.

**Aliases:** `consoleerror`

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/console#rconsolesettitle)

rconsolesettitle


---------------------------------------------------------------------------------------------------------

Sets the title of the console window to `title`.

**Aliases:** `rconsolename`, `consolesettitle`

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/console#rconsoleinfo)

rconsoleinfo


-------------------------------------------------------------------------------------------------

Prints `text` as an info message to the console window. Does not clear existing text or create a new line.

[PreviousCachechevron-left](https://mycompany-185.gitbook.io/mycompany-docs/cache)
[NextDebugchevron-right](https://mycompany-185.gitbook.io/mycompany-docs/debug)

Was this helpful?

*   [rconsoleclear](https://mycompany-185.gitbook.io/mycompany-docs/console#rconsoleclear)
    
*   [rconsolecreate](https://mycompany-185.gitbook.io/mycompany-docs/console#rconsolecreate)
    
*   [rconsoledestroy](https://mycompany-185.gitbook.io/mycompany-docs/console#rconsoledestroy)
    
*   [rconsoleinput](https://mycompany-185.gitbook.io/mycompany-docs/console#rconsoleinput)
    
*   [rconsoleprint](https://mycompany-185.gitbook.io/mycompany-docs/console#rconsoleprint)
    
*   [rconsolewarn](https://mycompany-185.gitbook.io/mycompany-docs/console#rconsolewarn)
    
*   [rconsoleerror](https://mycompany-185.gitbook.io/mycompany-docs/console#rconsoleerror)
    
*   [rconsolesettitle](https://mycompany-185.gitbook.io/mycompany-docs/console#rconsolesettitle)
    
*   [rconsoleinfo](https://mycompany-185.gitbook.io/mycompany-docs/console#rconsoleinfo)
    

Was this helpful?

Copy

    <nil> rconsoleprint(<string> text)

Copy

    <nil> rconsolewarn(<string> text)

Copy

    <nil> rconsoleerror(<string> text)

Copy

    <nil> rconsolesettitle(<string> title)

Copy

    <nil> rconsoleinfo(<string> text)

---

# Debug | MyCompany Docs

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/debug#debug.isvalidlevel)

`debug.isvalidlevel`


-------------------------------------------------------------------------------------------------------------

Copy

    <boolean> debug.isvalidlevel(<number> level)

Returns whether `level` is a valid level or not.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/debug#debug.getregistry)

`debug.getregistry`


-----------------------------------------------------------------------------------------------------------

Copy

    <table<function | thread>> debug.getregistry()

Returns the lua registry.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/debug#debug.getconstant)

`debug.getconstant`


-----------------------------------------------------------------------------------------------------------

Copy

    <any> debug.getconstant(<function | number> func, <number> index)

Returns the constant at `index` in the constant table of the function or level `func`. Throws an error if the constant does not exist.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/debug#debug.getconstants)

`debug.getconstants`


-------------------------------------------------------------------------------------------------------------

Copy

    <table<any>> debug.getconstants(<function | number> func)

Returns the constant table of the function or level `func`.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/debug#debug.getinfo)

`debug.getinfo`


---------------------------------------------------------------------------------------------------

Returns debugger information about a function or stack level.

### 

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/debug#debuginfo)

`DebugInfo`

Field

Type

Description

`source`

string

The name of the chunk that created the function.

`short_src`

string

A "printable" version of `source` to be used in error messages.

`func`

function

The function itself.

`what`

string

The string "Lua" if the function is a Luau function, or "C" if it is a C function.

`currentline`

number

The current line where the given function is executing.

`name`

string

The name of the function.

`nups`

number

The number of upvalues in the function.

`numparams`

number

The number of parameters in the function.

`is_vararg`

number

Whether the function has a variadic argument.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/debug#debug.getproto)

`debug.getproto`


-----------------------------------------------------------------------------------------------------

Returns the proto at `index` in the function or level `func` if `active` is false.

If `active` is true, then every active function of the proto is returned.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/debug#debug.getprotos)

`debug.getprotos`


-------------------------------------------------------------------------------------------------------

Returns a list of protos of the function or level `func`.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/debug#debug.getstack)

`debug.getstack`


-----------------------------------------------------------------------------------------------------

Returns the value at `index` in the stack frame `level`. Throws an error if no value could be found.

If `index` is not specified, then the entire stack frame is returned.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/debug#debug.getupvalue)

`debug.getupvalue`


---------------------------------------------------------------------------------------------------------

Returns the upvalue at `index` in the function or level `func`. Throws an error if the upvalue does not exist.

An upvalue is a local variable used by an inner function, and is also called an _external local variable_.

Read more on [Lua visibility rulesarrow-up-right](http://www.lua.org/manual/5.1/manual.html#2.6)
.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/debug#debug.getupvalues)

`debug.getupvalues`


-----------------------------------------------------------------------------------------------------------

Returns a list of upvalues of the function or level `func`.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/debug#debug.setconstant)

`debug.setconstant`


-----------------------------------------------------------------------------------------------------------

Sets the constant at `index` in the function or level `func` to `value`.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/debug#debug.setstack)

`debug.setstack`


-----------------------------------------------------------------------------------------------------

Sets the register at `index` in the stack frame `level` to `value`.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/debug#debug.setupvalue)

`debug.setupvalue`


---------------------------------------------------------------------------------------------------------

Sets the upvalue at `index` in the function or level `func` to `value`.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/debug#debug.setname)

`debug.setname`


---------------------------------------------------------------------------------------------------

Sets the debug name of `func` to `name`.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/debug#debug.getmetatable)

`debug.getmetatable`


-------------------------------------------------------------------------------------------------------------

Returns the metatable of `object`, bypassing the `__metatable` metamethod.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/debug#debug.setmetatable)

`debug.setmetatable`


-------------------------------------------------------------------------------------------------------------

Sets the metatable of `object` to `metatable`, bypassing the `__metatable` metamethod.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/debug#debug.getcallstack)

`debug.getcallstack`


-------------------------------------------------------------------------------------------------------------

Returns the current call stack as a table. Each entry contains debug information about a stack frame.

### 

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/debug#callstackentry)

`CallStackEntry`

Field

Type

Description

`func`

function

The function at this stack frame.

`line`

number

The current line number. `-1` for C functions.

`source`

string

The source of the function. `=[C]` for C functions.

`name`

string

The name of the function, if available.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/debug#debug.setinfo)

`debug.setinfo`


---------------------------------------------------------------------------------------------------

Sets debug information for `func`. Settable fields: `name`, `source`, `short_src`, `what`, `currentline`, `nups`, `numparams`, `is_vararg`.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/debug#setstackhidden)

`setstackhidden`


-----------------------------------------------------------------------------------------------------

Hides `func` from the call stack. The function will not appear in `debug.getcallstack` results.

[PreviousConsolechevron-left](https://mycompany-185.gitbook.io/mycompany-docs/console)
[NextDrawingchevron-right](https://mycompany-185.gitbook.io/mycompany-docs/drawing)

Was this helpful?

*   [debug.isvalidlevel](https://mycompany-185.gitbook.io/mycompany-docs/debug#debug.isvalidlevel)
    
*   [debug.getregistry](https://mycompany-185.gitbook.io/mycompany-docs/debug#debug.getregistry)
    
*   [debug.getconstant](https://mycompany-185.gitbook.io/mycompany-docs/debug#debug.getconstant)
    
*   [debug.getconstants](https://mycompany-185.gitbook.io/mycompany-docs/debug#debug.getconstants)
    
*   [debug.getinfo](https://mycompany-185.gitbook.io/mycompany-docs/debug#debug.getinfo)
    
*   [DebugInfo](https://mycompany-185.gitbook.io/mycompany-docs/debug#debuginfo)
    
*   [debug.getproto](https://mycompany-185.gitbook.io/mycompany-docs/debug#debug.getproto)
    
*   [debug.getprotos](https://mycompany-185.gitbook.io/mycompany-docs/debug#debug.getprotos)
    
*   [debug.getstack](https://mycompany-185.gitbook.io/mycompany-docs/debug#debug.getstack)
    
*   [debug.getupvalue](https://mycompany-185.gitbook.io/mycompany-docs/debug#debug.getupvalue)
    
*   [debug.getupvalues](https://mycompany-185.gitbook.io/mycompany-docs/debug#debug.getupvalues)
    
*   [debug.setconstant](https://mycompany-185.gitbook.io/mycompany-docs/debug#debug.setconstant)
    
*   [debug.setstack](https://mycompany-185.gitbook.io/mycompany-docs/debug#debug.setstack)
    
*   [debug.setupvalue](https://mycompany-185.gitbook.io/mycompany-docs/debug#debug.setupvalue)
    
*   [debug.setname](https://mycompany-185.gitbook.io/mycompany-docs/debug#debug.setname)
    
*   [debug.getmetatable](https://mycompany-185.gitbook.io/mycompany-docs/debug#debug.getmetatable)
    
*   [debug.setmetatable](https://mycompany-185.gitbook.io/mycompany-docs/debug#debug.setmetatable)
    
*   [debug.getcallstack](https://mycompany-185.gitbook.io/mycompany-docs/debug#debug.getcallstack)
    
*   [CallStackEntry](https://mycompany-185.gitbook.io/mycompany-docs/debug#callstackentry)
    
*   [debug.setinfo](https://mycompany-185.gitbook.io/mycompany-docs/debug#debug.setinfo)
    
*   [setstackhidden](https://mycompany-185.gitbook.io/mycompany-docs/debug#setstackhidden)
    

Was this helpful?

Copy

    <DebugInfo> debug.getinfo(<function | number> func)

Copy

    <function | table<function>> debug.getproto(<function | number> func, <number> index, <boolean?> active)

Copy

    <table<function>> debug.getprotos(<function | number> func)

Copy

    <any | table<any>> debug.getstack(<function | number> func, <number?> index)

Copy

    <any> debug.getupvalue(<function | number> func, <number> index)

Copy

    <table<any>> debug.getupvalues(<function | number> func)

Copy

    <nil> debug.setconstant(<function | number> func, <number> index, <any> value)

Copy

    <nil> debug.setstack(<function | number> func, <number> index, <any> value)

Copy

    <nil> debug.setupvalue(<function | number> func, <number> index, <any> value)

Copy

    <nil> debug.setname(<function> func, <string> name)

Copy

    <table> debug.getmetatable(<table> object)

Copy

    <nil> debug.setmetatable(<table> object, <table> metatable)

Copy

    <table> debug.getcallstack()

Copy

    <nil> debug.setinfo(<function> func, <table> info)

Copy

    <nil> setstackhidden(<function> func)

---

# Drawing | MyCompany Docs

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/drawing#drawing.new)

Drawing.new


-----------------------------------------------------------------------------------------------

Copy

    <DrawingObject> Drawing.new(<string> type)

Create a new drawing object of the specified type.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/drawing#objects)

Objects


---------------------------------------------------------------------------------------

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/drawing#drawingobject)

DrawingObject


---------------------------------------------------------------------------------------------------

### 

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/drawing#basedrawingobject)

BaseDrawingObject

Property

Type

Visible

boolean

ZIndex

number

Transparency

number

Color

Color3

Destroy

function

### 

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/drawing#line)

Line

Property

Type

From

Vector2

To

Vector2

Thickness

number

### 

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/drawing#text)

Text

Property

Type

Text

string

TextBounds

Vector2

Font

number

Size

number

Position

Vector2

Center

boolean

Outline

boolean

OutlineColor

Color3

### 

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/drawing#image)

Image

Property

Type

Data

string

Size

Vector2

Position

Vector2

Rounding

number

### 

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/drawing#circle)

Circle

Property

Type

NumSides

number

Radius

number

Position

Vector2

Thickness

number

Filled

boolean

### 

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/drawing#square)

Square

Property

Type

Size

Vector2

Position

Vector2

Thickness

number

Filled

boolean

### 

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/drawing#quad)

Quad

Property

Type

PointA

Vector2

PointB

Vector2

PointC

Vector2

PointD

Vector2

Thickness

number

Filled

boolean

### 

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/drawing#triangle)

Triangle

Property

Type

PointA

Vector2

PointB

Vector2

PointC

Vector2

Thickness

number

Filled

boolean

### 

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/drawing#font)

Font

Property

Type

Visible

boolean

ZIndex

number

Font

number

Data

string

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/drawing#drawing.fonts)

Drawing.Fonts


---------------------------------------------------------------------------------------------------

Index

Value

0

UI

1

System

2

Plex

3

Monospace

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/drawing#cleardrawcache)

cleardrawcache


-----------------------------------------------------------------------------------------------------

Destroys every drawing object in the cache. Invalidates references to the drawing objects.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/drawing#getrenderproperty)

getrenderproperty


-----------------------------------------------------------------------------------------------------------

Gets the value of a property of a drawing. Functionally identical to `drawing[property]`.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/drawing#isrenderobj)

isrenderobj


-----------------------------------------------------------------------------------------------

Returns whether the given object is a valid Drawing.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/drawing#setrenderproperty)

setrenderproperty


-----------------------------------------------------------------------------------------------------------

Sets the value of a property of a drawing. Functionally identical to `drawing[property] = value`.

[PreviousDebugchevron-left](https://mycompany-185.gitbook.io/mycompany-docs/debug)
[NextFile Systemchevron-right](https://mycompany-185.gitbook.io/mycompany-docs/file-system)

Was this helpful?

*   [Drawing.new](https://mycompany-185.gitbook.io/mycompany-docs/drawing#drawing.new)
    
*   [Objects](https://mycompany-185.gitbook.io/mycompany-docs/drawing#objects)
    
*   [DrawingObject](https://mycompany-185.gitbook.io/mycompany-docs/drawing#drawingobject)
    
*   [BaseDrawingObject](https://mycompany-185.gitbook.io/mycompany-docs/drawing#basedrawingobject)
    
*   [Line](https://mycompany-185.gitbook.io/mycompany-docs/drawing#line)
    
*   [Text](https://mycompany-185.gitbook.io/mycompany-docs/drawing#text)
    
*   [Image](https://mycompany-185.gitbook.io/mycompany-docs/drawing#image)
    
*   [Circle](https://mycompany-185.gitbook.io/mycompany-docs/drawing#circle)
    
*   [Square](https://mycompany-185.gitbook.io/mycompany-docs/drawing#square)
    
*   [Quad](https://mycompany-185.gitbook.io/mycompany-docs/drawing#quad)
    
*   [Triangle](https://mycompany-185.gitbook.io/mycompany-docs/drawing#triangle)
    
*   [Font](https://mycompany-185.gitbook.io/mycompany-docs/drawing#font)
    
*   [Drawing.Fonts](https://mycompany-185.gitbook.io/mycompany-docs/drawing#drawing.fonts)
    
*   [cleardrawcache](https://mycompany-185.gitbook.io/mycompany-docs/drawing#cleardrawcache)
    
*   [getrenderproperty](https://mycompany-185.gitbook.io/mycompany-docs/drawing#getrenderproperty)
    
*   [isrenderobj](https://mycompany-185.gitbook.io/mycompany-docs/drawing#isrenderobj)
    
*   [setrenderproperty](https://mycompany-185.gitbook.io/mycompany-docs/drawing#setrenderproperty)
    

Was this helpful?

Copy

    <nil> cleardrawcache()

Copy

    <any> getrenderproperty(<DrawingObject> drawing, <string> property)

Copy

    <boolean> isrenderobj(<any> object)

Copy

    <nil> setrenderproperty(<DrawingObject> drawing, <string> property, <any> value)

---

# File System | MyCompany Docs

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/file-system#readfile)

readfile


---------------------------------------------------------------------------------------------

Copy

    <string> readfile(<string> path)

Returns the contents of the file located at `path`.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/file-system#listfiles)

listfiles


-----------------------------------------------------------------------------------------------

Copy

    <table<string>> listfiles(<string> path)

Returns a list of files and folders in the folder located at `path`. The returned list contains whole paths.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/file-system#writefile)

writefile


-----------------------------------------------------------------------------------------------

Copy

    <nil> writefile(<string> path, <string> data)

Writes `data` to the file located at `path` if it is not a folder.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/file-system#makefolder)

makefolder


-------------------------------------------------------------------------------------------------

Copy

    <nil> makefolder(<string> path)

Creates a folder at `path` if it does not already exist.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/file-system#appendfile)

appendfile


-------------------------------------------------------------------------------------------------

Appends `data` to the end of the file located at `path`. Creates the file if it does not exist.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/file-system#isfile)

isfile


-----------------------------------------------------------------------------------------

Returns whether or not `path` points to a file.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/file-system#isfolder)

isfolder


---------------------------------------------------------------------------------------------

Returns whether or not `path` points to a folder.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/file-system#delfile)

delfile


-------------------------------------------------------------------------------------------

Removes the file located at `path`.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/file-system#delfolder)

delfolder


-----------------------------------------------------------------------------------------------

Removes the folder located at `path`.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/file-system#loadfile)

loadfile


---------------------------------------------------------------------------------------------

Generates a chunk from the file located at `path`. The environment of the returned function is the global environment.

If there are no compilation errors, the chunk is returned by itself; otherwise, it returns `nil` plus the error message.

`chunkname` is used as the chunk name for error messages and debug information.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/file-system#dofile)

dofile


-----------------------------------------------------------------------------------------

Attempts to load the file located at `path` and execute it on a new thread.

[PreviousDrawingchevron-left](https://mycompany-185.gitbook.io/mycompany-docs/drawing)
[NextInputchevron-right](https://mycompany-185.gitbook.io/mycompany-docs/input)

Was this helpful?

*   [readfile](https://mycompany-185.gitbook.io/mycompany-docs/file-system#readfile)
    
*   [listfiles](https://mycompany-185.gitbook.io/mycompany-docs/file-system#listfiles)
    
*   [writefile](https://mycompany-185.gitbook.io/mycompany-docs/file-system#writefile)
    
*   [makefolder](https://mycompany-185.gitbook.io/mycompany-docs/file-system#makefolder)
    
*   [appendfile](https://mycompany-185.gitbook.io/mycompany-docs/file-system#appendfile)
    
*   [isfile](https://mycompany-185.gitbook.io/mycompany-docs/file-system#isfile)
    
*   [isfolder](https://mycompany-185.gitbook.io/mycompany-docs/file-system#isfolder)
    
*   [delfile](https://mycompany-185.gitbook.io/mycompany-docs/file-system#delfile)
    
*   [delfolder](https://mycompany-185.gitbook.io/mycompany-docs/file-system#delfolder)
    
*   [loadfile](https://mycompany-185.gitbook.io/mycompany-docs/file-system#loadfile)
    
*   [dofile](https://mycompany-185.gitbook.io/mycompany-docs/file-system#dofile)
    

Was this helpful?

Copy

    <nil> appendfile(<string> path, <string> data)

Copy

    <boolean> isfile(<string> path)

Copy

    <boolean> isfolder(<string> path)

Copy

    <nil> delfile(<string> path)

Copy

    <nil> delfolder(<string> path)

Copy

    <function?, string?> loadfile(<string> path, <string?> chunkname)

Copy

    <nil> dofile(<string> path)

---

# Input | MyCompany Docs

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/input#isrbxactive)

isrbxactive


---------------------------------------------------------------------------------------------

Copy

    <boolean> isrbxactive()

Returns whether the game's window is in focus. Must be true for other input functions to work.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/input#mouse1click)

mouse1click


---------------------------------------------------------------------------------------------

Copy

    <nil> mouse1click()

Dispatches a left mouse button click.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/input#mouse1press)

mouse1press


---------------------------------------------------------------------------------------------

Copy

    <nil> mouse1press()

Dispatches a left mouse button press.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/input#mouse1release)

mouse1release


-------------------------------------------------------------------------------------------------

Copy

    <nil> mouse1release()

Dispatches a left mouse button release.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/input#mouse2click)

mouse2click


---------------------------------------------------------------------------------------------

Dispatches a right mouse button click.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/input#mouse2press)

mouse2press


---------------------------------------------------------------------------------------------

Dispatches a right mouse button press.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/input#mouse2release)

mouse2release


-------------------------------------------------------------------------------------------------

Dispatches a right mouse button release.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/input#mousemoveabs)

mousemoveabs


-----------------------------------------------------------------------------------------------

Moves the mouse cursor to the specified absolute position.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/input#mousemoverel)

mousemoverel


-----------------------------------------------------------------------------------------------

Adjusts the mouse cursor by the specified relative amount.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/input#mousescroll)

mousescroll


---------------------------------------------------------------------------------------------

Dispatches a mouse scroll by the specified number of pixels.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/input#keytap)

keytap


-----------------------------------------------------------------------------------

Simulates a key press and release for the given virtual key code. `keyCode` is a Windows virtual-key code (e.g. `0x41` for the A key).

[PreviousFile Systemchevron-left](https://mycompany-185.gitbook.io/mycompany-docs/file-system)
[NextInstancechevron-right](https://mycompany-185.gitbook.io/mycompany-docs/instance)

Was this helpful?

*   [isrbxactive](https://mycompany-185.gitbook.io/mycompany-docs/input#isrbxactive)
    
*   [mouse1click](https://mycompany-185.gitbook.io/mycompany-docs/input#mouse1click)
    
*   [mouse1press](https://mycompany-185.gitbook.io/mycompany-docs/input#mouse1press)
    
*   [mouse1release](https://mycompany-185.gitbook.io/mycompany-docs/input#mouse1release)
    
*   [mouse2click](https://mycompany-185.gitbook.io/mycompany-docs/input#mouse2click)
    
*   [mouse2press](https://mycompany-185.gitbook.io/mycompany-docs/input#mouse2press)
    
*   [mouse2release](https://mycompany-185.gitbook.io/mycompany-docs/input#mouse2release)
    
*   [mousemoveabs](https://mycompany-185.gitbook.io/mycompany-docs/input#mousemoveabs)
    
*   [mousemoverel](https://mycompany-185.gitbook.io/mycompany-docs/input#mousemoverel)
    
*   [mousescroll](https://mycompany-185.gitbook.io/mycompany-docs/input#mousescroll)
    
*   [keytap](https://mycompany-185.gitbook.io/mycompany-docs/input#keytap)
    

Was this helpful?

Copy

    <nil> mouse2click()

Copy

    <nil> mouse2press()

Copy

    <nil> mouse2release()

Copy

    <nil> mousemoveabs(<number> x, <number> y)

Copy

    <nil> mousemoverel(<number> x, <number> y)

Copy

    <nil> mousescroll(<number> pixels)

Copy

    <nil> keytap(<number> keyCode, <number?> delay)

Copy

    keytap(0x41) -- Taps the A key
    keytap(0x0D) -- Taps Enter

---

# Metatable | MyCompany Docs

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/metatable#getrawmetatable)

getrawmetatable


---------------------------------------------------------------------------------------------------------

Copy

    <table> getrawmetatable(<table> object)

Returns the metatable of `object`, where the `__metatable` field would normally lock the metatable.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/metatable#hookmetamethod)

hookmetamethod


-------------------------------------------------------------------------------------------------------

Copy

    <function> hookmetamethod(<table> object, <string> method, <function> hook)

Replaces `func` with `hook` internally, where `hook` will be invoked in place of `func` when called.

Returns a new function that can be used to access the original definition of `func`.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/metatable#getnamecallmethod)

getnamecallmethod


-------------------------------------------------------------------------------------------------------------

Copy

    <string> getnamecallmethod()

Returns the name of the method that invoked the `__namecall` metamethod.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/metatable#setnamecallmethod)

setnamecallmethod


-------------------------------------------------------------------------------------------------------------

Copy

    <nil> setnamecallmethod(<string> method)

Changes the name of the method that invoked `__namecall` metamethod.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/metatable#isreadonly)

isreadonly


-----------------------------------------------------------------------------------------------

Returns whether `object` is read-only or not.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/metatable#setrawmetatable)

setrawmetatable


---------------------------------------------------------------------------------------------------------

Sets the metatable of `object` to `metatable`, where the `__metatable` field would normally lock the metatable.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/metatable#setreadonly)

setreadonly


-------------------------------------------------------------------------------------------------

Sets whether `object` is read-only or not.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/metatable#makewriteable)

makewriteable


-----------------------------------------------------------------------------------------------------

Unfreezes `object`.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/metatable#makereadonly)

makereadonly


---------------------------------------------------------------------------------------------------

Freezes `object`, where table.freeze would normally check for `__metatable`.

[PreviousInstancechevron-left](https://mycompany-185.gitbook.io/mycompany-docs/instance)
[NextMiscellaneouschevron-right](https://mycompany-185.gitbook.io/mycompany-docs/miscellaneous)

Was this helpful?

*   [getrawmetatable](https://mycompany-185.gitbook.io/mycompany-docs/metatable#getrawmetatable)
    
*   [hookmetamethod](https://mycompany-185.gitbook.io/mycompany-docs/metatable#hookmetamethod)
    
*   [getnamecallmethod](https://mycompany-185.gitbook.io/mycompany-docs/metatable#getnamecallmethod)
    
*   [setnamecallmethod](https://mycompany-185.gitbook.io/mycompany-docs/metatable#setnamecallmethod)
    
*   [isreadonly](https://mycompany-185.gitbook.io/mycompany-docs/metatable#isreadonly)
    
*   [setrawmetatable](https://mycompany-185.gitbook.io/mycompany-docs/metatable#setrawmetatable)
    
*   [setreadonly](https://mycompany-185.gitbook.io/mycompany-docs/metatable#setreadonly)
    
*   [makewriteable](https://mycompany-185.gitbook.io/mycompany-docs/metatable#makewriteable)
    
*   [makereadonly](https://mycompany-185.gitbook.io/mycompany-docs/metatable#makereadonly)
    

Was this helpful?

Copy

    <boolean> isreadonly(<table> object)

Copy

    <nil> setrawmetatable(<table> object, <table> metatable)

Copy

    <nil> setreadonly(<table> object, <boolean> readonly)

Copy

    <nil> makewriteable(<table> object)

Copy

    <nil> makereadonly(<table> object)

---

# Instance | MyCompany Docs

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/instance#fireclickdetector)

`fireclickdetector`


--------------------------------------------------------------------------------------------------------------

Copy

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

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

`mode` specifies the type of interaction to simulate. Valid values are `0` (MouseClick), `1` (MouseHoverEnter), and `2` (MouseHoverLeave).

Copy

    local clickDetector = workspace.Door.Button.ClickDetector
    fireclickdetector(clickDetector, 10 + math.random())
    fireclickdetector(clickDetector, 10, 1) -- Simulate hover enter

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/instance#firetouchinterest)

`firetouchinterest`


--------------------------------------------------------------------------------------------------------------

Copy

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

Simulates a touch event between two parts.

Copy

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

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/instance#isnetworkowner)

`isnetworkowner`


--------------------------------------------------------------------------------------------------------

Copy

    <bool> isnetworkowner(<Instance> part)

Returns `true` if the Part is owned by the player.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/instance#getcallbackvalue)

`getcallbackvalue`


------------------------------------------------------------------------------------------------------------

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

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/instance#fireproximityprompt)

`fireproximityprompt`


------------------------------------------------------------------------------------------------------------------

Fires the trigger of `prompt`.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/instance#getconnections)

`getconnections`


--------------------------------------------------------------------------------------------------------

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

### 

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/instance#fields)

Fields

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.

### 

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/instance#methods)

Methods

Method

Description

`Fire(...: any): ()`

Fires this connection with the provided arguments.

`Defer(...: any): ()`

[Defersarrow-up-right](https://devforum.roblox.com/t/beta-deferred-lua-event-handling/1240569)
 an event to connection with the provided arguments.

`Disconnect(): ()`

Disconnects the connection.

`Disable(): ()`

Prevents the connection from firing.

`Enable(): ()`

Allows the connection to fire if it was previously disabled.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/instance#getconnection)

`getconnection`


------------------------------------------------------------------------------------------------------

Returns a Connection object for `index`.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/instance#firesignal)

`firesignal`


------------------------------------------------------------------------------------------------

Fires all Lua connections of `signal`.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/instance#getcustomasset)

`getcustomasset`


--------------------------------------------------------------------------------------------------------

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.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/instance#gethiddenproperty)

`gethiddenproperty`


--------------------------------------------------------------------------------------------------------------

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`.

**Aliases:** `gethiddenprop`

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/instance#setsimulationradius)

`setsimulationradius`


------------------------------------------------------------------------------------------------------------------

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

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/instance#gethui)

`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.

**Aliases:** `get_hidden_gui`

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/instance#getinstances)

`getinstances`


----------------------------------------------------------------------------------------------------

Returns a list of every Instance referenced on the client.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/instance#getnilinstances)

`getnilinstances`


----------------------------------------------------------------------------------------------------------

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

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/instance#isscriptable)

`isscriptable`


----------------------------------------------------------------------------------------------------

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.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/instance#sethiddenproperty)

`sethiddenproperty`


--------------------------------------------------------------------------------------------------------------

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

**Aliases:** `sethiddenprop`

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/instance#setrbxclipboard)

`setrbxclipboard`


----------------------------------------------------------------------------------------------------------

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.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/instance#setscriptable)

`setscriptable`


------------------------------------------------------------------------------------------------------

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

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/instance#getrendersteppedlist)

`getrendersteppedlist`


--------------------------------------------------------------------------------------------------------------------

Returns all callbacks bound with `RunService.BindToRenderStep`.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/instance#replicatesignal)

`replicatesignal`


----------------------------------------------------------------------------------------------------------

Replicates `signal` on the server.

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

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/instance#getsimulationradius)

`getsimulationradius`


------------------------------------------------------------------------------------------------------------------

Returns the player's current simulation radius.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/instance#setproximitypromptduration)

`setproximitypromptduration`


--------------------------------------------------------------------------------------------------------------------------------

Sets the `HoldDuration` of `prompt` to `duration`.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/instance#getproximitypromptduration)

`getproximitypromptduration`


--------------------------------------------------------------------------------------------------------------------------------

Returns the `HoldDuration` of `prompt`.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/instance#gethiddenproperties)

`gethiddenproperties`


------------------------------------------------------------------------------------------------------------------

Returns a table of hidden property names for `object`.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/instance#getproperties)

`getproperties`


------------------------------------------------------------------------------------------------------

Returns a table of property names for `object`.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/instance#getscriptthread)

`getscriptthread`


----------------------------------------------------------------------------------------------------------

Returns the thread associated with the given `script`.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/instance#cansignalreplicate)

`cansignalreplicate`


----------------------------------------------------------------------------------------------------------------

Returns whether `signal` can be replicated to the server.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/instance#getsignalwhitelist)

`getsignalwhitelist`


----------------------------------------------------------------------------------------------------------------

Returns a table of whitelisted signals that can be replicated.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/instance#getsignalarguments)

`getsignalarguments`


----------------------------------------------------------------------------------------------------------------

Returns a table of argument types for `signal`.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/instance#getsignalargumentsinfo)

`getsignalargumentsinfo`


------------------------------------------------------------------------------------------------------------------------

Returns a table of detailed argument information for `signal`. Each entry contains `Name` and `Type` fields.

[PreviousInputchevron-left](https://mycompany-185.gitbook.io/mycompany-docs/input)
[NextMetatablechevron-right](https://mycompany-185.gitbook.io/mycompany-docs/metatable)

Was this helpful?

*   [fireclickdetector](https://mycompany-185.gitbook.io/mycompany-docs/instance#fireclickdetector)
    
*   [firetouchinterest](https://mycompany-185.gitbook.io/mycompany-docs/instance#firetouchinterest)
    
*   [isnetworkowner](https://mycompany-185.gitbook.io/mycompany-docs/instance#isnetworkowner)
    
*   [getcallbackvalue](https://mycompany-185.gitbook.io/mycompany-docs/instance#getcallbackvalue)
    
*   [fireproximityprompt](https://mycompany-185.gitbook.io/mycompany-docs/instance#fireproximityprompt)
    
*   [getconnections](https://mycompany-185.gitbook.io/mycompany-docs/instance#getconnections)
    
*   [Fields](https://mycompany-185.gitbook.io/mycompany-docs/instance#fields)
    
*   [Methods](https://mycompany-185.gitbook.io/mycompany-docs/instance#methods)
    
*   [getconnection](https://mycompany-185.gitbook.io/mycompany-docs/instance#getconnection)
    
*   [firesignal](https://mycompany-185.gitbook.io/mycompany-docs/instance#firesignal)
    
*   [getcustomasset](https://mycompany-185.gitbook.io/mycompany-docs/instance#getcustomasset)
    
*   [gethiddenproperty](https://mycompany-185.gitbook.io/mycompany-docs/instance#gethiddenproperty)
    
*   [setsimulationradius](https://mycompany-185.gitbook.io/mycompany-docs/instance#setsimulationradius)
    
*   [gethui](https://mycompany-185.gitbook.io/mycompany-docs/instance#gethui)
    
*   [getinstances](https://mycompany-185.gitbook.io/mycompany-docs/instance#getinstances)
    
*   [getnilinstances](https://mycompany-185.gitbook.io/mycompany-docs/instance#getnilinstances)
    
*   [isscriptable](https://mycompany-185.gitbook.io/mycompany-docs/instance#isscriptable)
    
*   [sethiddenproperty](https://mycompany-185.gitbook.io/mycompany-docs/instance#sethiddenproperty)
    
*   [setrbxclipboard](https://mycompany-185.gitbook.io/mycompany-docs/instance#setrbxclipboard)
    
*   [setscriptable](https://mycompany-185.gitbook.io/mycompany-docs/instance#setscriptable)
    
*   [getrendersteppedlist](https://mycompany-185.gitbook.io/mycompany-docs/instance#getrendersteppedlist)
    
*   [replicatesignal](https://mycompany-185.gitbook.io/mycompany-docs/instance#replicatesignal)
    
*   [getsimulationradius](https://mycompany-185.gitbook.io/mycompany-docs/instance#getsimulationradius)
    
*   [setproximitypromptduration](https://mycompany-185.gitbook.io/mycompany-docs/instance#setproximitypromptduration)
    
*   [getproximitypromptduration](https://mycompany-185.gitbook.io/mycompany-docs/instance#getproximitypromptduration)
    
*   [gethiddenproperties](https://mycompany-185.gitbook.io/mycompany-docs/instance#gethiddenproperties)
    
*   [getproperties](https://mycompany-185.gitbook.io/mycompany-docs/instance#getproperties)
    
*   [getscriptthread](https://mycompany-185.gitbook.io/mycompany-docs/instance#getscriptthread)
    
*   [cansignalreplicate](https://mycompany-185.gitbook.io/mycompany-docs/instance#cansignalreplicate)
    
*   [getsignalwhitelist](https://mycompany-185.gitbook.io/mycompany-docs/instance#getsignalwhitelist)
    
*   [getsignalarguments](https://mycompany-185.gitbook.io/mycompany-docs/instance#getsignalarguments)
    
*   [getsignalargumentsinfo](https://mycompany-185.gitbook.io/mycompany-docs/instance#getsignalargumentsinfo)
    

Was this helpful?

Copy

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

Copy

    <nil> fireproximityprompt(<ProximityPrompt> prompt)

Copy

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

Copy

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

Copy

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

Copy

    <string> getcustomasset(<string> path)

Copy

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

Copy

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

Copy

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

Copy

    <Folder> gethui()

Copy

    <table<Instance>> getinstances()

Copy

    <table<Instance>> getnilinstances()

Copy

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

Copy

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

Copy

    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)

Copy

    <boolean> setrbxclipboard(<string> data)

Copy

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

Copy

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

Copy

    <table> getrendersteppedlist()

Copy

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

Copy

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

Copy

    <number> getsimulationradius()

Copy

    <nil> setproximitypromptduration(<ProximityPrompt> prompt, <number> duration)

Copy

    <number> getproximitypromptduration(<ProximityPrompt> prompt)

Copy

    <table> gethiddenproperties(<Instance> object)

Copy

    <table> getproperties(<Instance> object)

Copy

    <thread> getscriptthread(<LocalScript | ModuleScript> script)

Copy

    <boolean> cansignalreplicate(<RBXScriptSignal> signal)

Copy

    <table> getsignalwhitelist()

Copy

    <table> getsignalarguments(<RBXScriptSignal> signal)

Copy

    local args = getsignalarguments(workspace.Part.Touched)
    print(args[1]) --> Instance

Copy

    <table> getsignalargumentsinfo(<RBXScriptSignal> signal)

Copy

    local info = getsignalargumentsinfo(workspace.Part.Touched)
    print(info[1].Name) --> otherPart
    print(info[1].Type) --> Instance

---

# RakNet | MyCompany Docs

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/raknet#raknet.send)

RakNet.send


----------------------------------------------------------------------------------------------

Copy

    <nil> RakNet.send(<string> data)

Sends raw data over the RakNet connection.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/raknet#raknet.add_send_hook)

RakNet.add\_send\_hook


------------------------------------------------------------------------------------------------------------------

Copy

    <nil> RakNet.add_send_hook(<function> hook)

Adds a hook function that intercepts outgoing RakNet packets. The hook receives the packet data as an argument.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/raknet#raknet.remove_send_hook)

RakNet.remove\_send\_hook


------------------------------------------------------------------------------------------------------------------------

Copy

    <nil> RakNet.remove_send_hook(<function> hook)

Removes a previously added send hook.

[Previousothchevron-left](https://mycompany-185.gitbook.io/mycompany-docs/oth)
[NextRegexchevron-right](https://mycompany-185.gitbook.io/mycompany-docs/regex)

Was this helpful?

*   [RakNet.send](https://mycompany-185.gitbook.io/mycompany-docs/raknet#raknet.send)
    
*   [RakNet.add\_send\_hook](https://mycompany-185.gitbook.io/mycompany-docs/raknet#raknet.add_send_hook)
    
*   [RakNet.remove\_send\_hook](https://mycompany-185.gitbook.io/mycompany-docs/raknet#raknet.remove_send_hook)
    

Was this helpful?

---

# Web Sockets | MyCompany Docs

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/web-sockets#websocket.connect)

WebSocket.connect


---------------------------------------------------------------------------------------------------------------

Copy

    <WebSocketConnection> WebSocket.connect(<string> url)

Establishes a WebSocket connection to the specified URL.

The `WebSocket` class is also available under the lowercase alias `websocket`.

Copy

    local ws = WebSocket.connect("ws://localhost:8080")
    
    ws.OnMessage:Connect(function(message)
    	print(message)
    end)
    
    ws.OnClose:Connect(function()
    	print("Closed")
    end)
    
    ws:Send("Hello, World!")

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/web-sockets#websocketconnection)

WebSocketConnection


-------------------------------------------------------------------------------------------------------------------

Copy

    ws = WebSocket.connect(url)

### 

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/web-sockets#methods)

Methods

Method

Description

`Send(<string> message)`

Sends a message over the WebSocket connection

`Close()`

Closes the WebSocket connection

### 

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/web-sockets#events)

Events

Event

Description

`OnMessage(<string> message)`

Fired when a message is received over the WebSocket connection

`OnClose()`

Fired when the WebSocket connection is closed

[PreviousScriptschevron-left](https://mycompany-185.gitbook.io/mycompany-docs/scripts)
[NextClosureschevron-right](https://mycompany-185.gitbook.io/mycompany-docs/closures)

Was this helpful?

*   [WebSocket.connect](https://mycompany-185.gitbook.io/mycompany-docs/web-sockets#websocket.connect)
    
*   [WebSocketConnection](https://mycompany-185.gitbook.io/mycompany-docs/web-sockets#websocketconnection)
    
*   [Methods](https://mycompany-185.gitbook.io/mycompany-docs/web-sockets#methods)
    
*   [Events](https://mycompany-185.gitbook.io/mycompany-docs/web-sockets#events)
    

Was this helpful?

---

# Crypt | MyCompany Docs

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/crypt#crypt.base64encode)

crypt.base64encode


-----------------------------------------------------------------------------------------------------------

Copy

    <string> crypt.base64encode(<string> data)

Encodes a string of bytes into Base64.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/crypt#crypt.base64decode)

crypt.base64decode


-----------------------------------------------------------------------------------------------------------

Copy

    <string> crypt.base64decode(<string> data)

Decodes a Base64 string to a string of bytes.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/crypt#crypt.encrypt)

crypt.encrypt


-------------------------------------------------------------------------------------------------

Copy

    <string, string> crypt.encrypt(<string> data, <string> key, <string?> iv, <string?> mode)

Encrypts an unencoded string using AES encryption. Returns the base64 encoded and encrypted string, and the IV.

If an AES IV is not provided, a random one will be generated for you, and returned as a 2nd base64 encoded string.

The cipher modes are `CBC`, `ECB`, `CTR`, `CFB`, `OFB`, and `GCM`. The default is `CBC`.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/crypt#crypt.decrypt)

crypt.decrypt


-------------------------------------------------------------------------------------------------

Copy

    <string> crypt.encrypt(<string> data, <string> key, <string> iv, <string> mode)

Decrypts the base64 encoded and encrypted content. Returns the raw string.

The cipher modes are `CBC`, `ECB`, `CTR`, `CFB`, `OFB`, and `GCM`.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/crypt#crypt.generatebytes)

crypt.generatebytes


-------------------------------------------------------------------------------------------------------------

Generates a random sequence of bytes of the given size. Returns the sequence as a base64 encoded string.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/crypt#crypt.generatekey)

crypt.generatekey


---------------------------------------------------------------------------------------------------------

Generates a base64 encoded 256-bit key. The result can be used as the second parameter for the `crypt.encrypt` and `crypt.decrypt` functions.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/crypt#crypt.hash)

crypt.hash


-------------------------------------------------------------------------------------------

Returns the result of hashing the data using the given algorithm.

Some algorithms include `sha1`, `sha384`, `sha512`, `md5`, `sha256`, `sha3-224`, `sha3-256`, and `sha3-512`.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/crypt#crypt.random)

crypt.random


-----------------------------------------------------------------------------------------------

Generates a random sequence of `size` bytes. Returns the raw bytes as a string.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/crypt#crypt.hmac)

crypt.hmac


-------------------------------------------------------------------------------------------

Returns a base64-encoded HMAC of `data` using `key` and the given `algorithm`.

Supported algorithms: `sha1`, `sha256`, `sha384`, `sha512`, `md5`, `sha3-224`, `sha3-256`, `sha3-512`.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/crypt#crypt.lz4compress)

crypt.lz4compress


---------------------------------------------------------------------------------------------------------

Compresses `data` using LZ4 compression. Functionally identical to the global `lz4compress`.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/crypt#crypt.lz4decompress)

crypt.lz4decompress


-------------------------------------------------------------------------------------------------------------

Decompresses `data` using LZ4 compression, with the decompressed size specified by `size`. Functionally identical to the global `lz4decompress`.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/crypt#crypt.base64_encode)

crypt.base64\_encode


--------------------------------------------------------------------------------------------------------------

Encodes a string of bytes into Base64. Underscore alias for `crypt.base64encode`.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/crypt#crypt.base64_decode)

crypt.base64\_decode


--------------------------------------------------------------------------------------------------------------

Decodes a Base64 string to a string of bytes. Underscore alias for `crypt.base64decode`.

[PreviousClosureschevron-left](https://mycompany-185.gitbook.io/mycompany-docs/closures)
[Nextothchevron-right](https://mycompany-185.gitbook.io/mycompany-docs/oth)

Was this helpful?

*   [crypt.base64encode](https://mycompany-185.gitbook.io/mycompany-docs/crypt#crypt.base64encode)
    
*   [crypt.base64decode](https://mycompany-185.gitbook.io/mycompany-docs/crypt#crypt.base64decode)
    
*   [crypt.encrypt](https://mycompany-185.gitbook.io/mycompany-docs/crypt#crypt.encrypt)
    
*   [crypt.decrypt](https://mycompany-185.gitbook.io/mycompany-docs/crypt#crypt.decrypt)
    
*   [crypt.generatebytes](https://mycompany-185.gitbook.io/mycompany-docs/crypt#crypt.generatebytes)
    
*   [crypt.generatekey](https://mycompany-185.gitbook.io/mycompany-docs/crypt#crypt.generatekey)
    
*   [crypt.hash](https://mycompany-185.gitbook.io/mycompany-docs/crypt#crypt.hash)
    
*   [crypt.random](https://mycompany-185.gitbook.io/mycompany-docs/crypt#crypt.random)
    
*   [crypt.hmac](https://mycompany-185.gitbook.io/mycompany-docs/crypt#crypt.hmac)
    
*   [crypt.lz4compress](https://mycompany-185.gitbook.io/mycompany-docs/crypt#crypt.lz4compress)
    
*   [crypt.lz4decompress](https://mycompany-185.gitbook.io/mycompany-docs/crypt#crypt.lz4decompress)
    
*   [crypt.base64\_encode](https://mycompany-185.gitbook.io/mycompany-docs/crypt#crypt.base64_encode)
    
*   [crypt.base64\_decode](https://mycompany-185.gitbook.io/mycompany-docs/crypt#crypt.base64_decode)
    

Was this helpful?

Copy

    <string> crypt.generatebytes(<number> size)

Copy

    <string> crypt.generatekey()

Copy

    <string> crypt.hash(<string> data, <string> algo)

Copy

    <string> crypt.random(<number> size)

Copy

    <string> crypt.hmac(<string> data, <string> key, <string> algorithm)

Copy

    <string> crypt.lz4compress(<string> data)

Copy

    <string> crypt.lz4decompress(<string> data, <number> size)

Copy

    <string> crypt.base64_encode(<string> data)

Copy

    <string> crypt.base64_decode(<string> data)

---

# Closures | MyCompany Docs

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/closures#checkcaller)

checkcaller


------------------------------------------------------------------------------------------------

Copy

    <boolean> checkcaller()

Returns whether the function currently running was called by the executor.

This is useful for metamethod hooks that behave differently when called by the game.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/closures#clonefunction)

clonefunction


----------------------------------------------------------------------------------------------------

Copy

    <function> clonefunction(<function> func)

Generates a new closure based on the bytecode of function `func`.

Copy

    local function foo()
        print("Hello, world!")
    end
    
    local bar = clonefunction(foo)
    
    foo() --> Hello, world!
    bar() --> Hello, world!
    print(foo == bar) --> false

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/closures#getcallingscript)

getcallingscript


----------------------------------------------------------------------------------------------------------

Returns the script responsible for the currently running function.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/closures#hookfunction)

hookfunction


--------------------------------------------------------------------------------------------------

Replaces `func` with `hook` internally, where `hook` will be invoked in place of `func` when called.

Returns a new function that can be used to access the original definition of `func`.

If `func` is a Luau function (`islclosure(func) --> true`), the upvalue count of `hook` must be less than or equal to that of `func`. [Lua visibility rulesarrow-up-rightarrow-up-right](http://www.lua.org/manual/5.1/manual.html#2.6)

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/closures#iscclosure)

iscclosure


----------------------------------------------------------------------------------------------

Returns whether or not `func` is a closure whose source is written in C.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/closures#islclosure)

islclosure


----------------------------------------------------------------------------------------------

Returns whether or not `func` is a closure whose source is written in Luau.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/closures#isexecutorclosure)

isexecutorclosure


------------------------------------------------------------------------------------------------------------

Returns whether or not `func` was created by the executor.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/closures#loadstring)

loadstring


----------------------------------------------------------------------------------------------

Generates a chunk from the given source code. The environment of the returned function is the global environment.

If there are no compilation errors, the chunk is returned by itself; otherwise, it returns `nil` plus the error message.

`chunkname` is used as the chunk name for error messages and debug information.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/closures#newcclosure)

newcclosure


------------------------------------------------------------------------------------------------

Returns a C closure that wraps `func`. The result is functionally identical to `func`, but identifies as a C closure.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/closures#getfunctionhash)

getfunctionhash


--------------------------------------------------------------------------------------------------------

Returns a hash string of the bytecode of `func`. The same function always returns the same hash.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/closures#restorefunction)

restorefunction


--------------------------------------------------------------------------------------------------------

Restores `func` to its original definition, undoing any hooks applied by `hookfunction`.

**Aliases:** `restorefunc`

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/closures#newlclosure)

newlclosure


------------------------------------------------------------------------------------------------

Returns a Luau closure that wraps `func`. The result is functionally identical to `func`, but identifies as a Luau closure (`islclosure` returns `true`).

If `debugname` is specified, it will be used as the debug name of the returned closure.

[PreviousWeb Socketschevron-left](https://mycompany-185.gitbook.io/mycompany-docs/web-sockets)
[NextCryptchevron-right](https://mycompany-185.gitbook.io/mycompany-docs/crypt)

Was this helpful?

*   [checkcaller](https://mycompany-185.gitbook.io/mycompany-docs/closures#checkcaller)
    
*   [clonefunction](https://mycompany-185.gitbook.io/mycompany-docs/closures#clonefunction)
    
*   [getcallingscript](https://mycompany-185.gitbook.io/mycompany-docs/closures#getcallingscript)
    
*   [hookfunction](https://mycompany-185.gitbook.io/mycompany-docs/closures#hookfunction)
    
*   [iscclosure](https://mycompany-185.gitbook.io/mycompany-docs/closures#iscclosure)
    
*   [islclosure](https://mycompany-185.gitbook.io/mycompany-docs/closures#islclosure)
    
*   [isexecutorclosure](https://mycompany-185.gitbook.io/mycompany-docs/closures#isexecutorclosure)
    
*   [loadstring](https://mycompany-185.gitbook.io/mycompany-docs/closures#loadstring)
    
*   [newcclosure](https://mycompany-185.gitbook.io/mycompany-docs/closures#newcclosure)
    
*   [getfunctionhash](https://mycompany-185.gitbook.io/mycompany-docs/closures#getfunctionhash)
    
*   [restorefunction](https://mycompany-185.gitbook.io/mycompany-docs/closures#restorefunction)
    
*   [newlclosure](https://mycompany-185.gitbook.io/mycompany-docs/closures#newlclosure)
    

Was this helpful?

Copy

    <BaseScript> getcallingscript()

Copy

    <function> hookfunction(<function> func, <function> hook)

Copy

    local function foo()
        print("Hello, world!")
    end
    
    local fooRef = hookfunction(foo, function(...)
        print("Hooked!")
    end)
    
    foo() --> Hooked!
    fooRef() --> Hello, world!

Copy

    <boolean> iscclosure(<function> func)

Copy

    <boolean> islclosure(<function> func)

Copy

    <boolean> isexecutorclosure(<function> func)

Copy

    <function?, string?> loadstring(<string> source, <string?> chunkname)

Copy

    <function> newcclosure(<function> func)

Copy

    local foo = function() return true end
    local bar = newcclosure(foo)
    
    print(bar()) --> true

Copy

    <string> getfunctionhash(<function> func)

Copy

    local function foo() print("Hello") end
    local hash = getfunctionhash(foo)
    print(getfunctionhash(foo) == hash) --> true

Copy

    <nil> restorefunction(<function> func)

Copy

    local function foo() return "original" end
    hookfunction(foo, function() return "hooked" end)
    print(foo()) --> hooked
    restorefunction(foo)
    print(foo()) --> original

Copy

    <function> newlclosure(<function> func, <string?> debugname)

Copy

    local foo = newlclosure(function() return "test" end, "myname")
    print(islclosure(foo)) --> true

---

# Scripts | MyCompany Docs

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/scripts#getgc)

getgc


-----------------------------------------------------------------------------------

Copy

    <table<function | userdata | table>> getgc(<boolean?> includetables)

Returns a list of objects in the Luau garbage collector.

If `includeTables` is false, tables will not be included in the list.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/scripts#getgenv)

getgenv


---------------------------------------------------------------------------------------

Copy

    <table<[string]: any>> getgenv()

Returns the custom global environment of the executor.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/scripts#gettenv)

gettenv


---------------------------------------------------------------------------------------

Copy

    <table<[string]: any> gettenv(<thread> thread)

Returns the environment of `thread`.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/scripts#getreg)

getreg


-------------------------------------------------------------------------------------

Copy

    <table<function | thread>> getreg()

Returns the lua registry.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/scripts#getloadedmodules)

getloadedmodules


---------------------------------------------------------------------------------------------------------

Returns a list of ModuleScripts that have been loaded.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/scripts#getrenv)

getrenv


---------------------------------------------------------------------------------------

Returns the global environment of the game client. It can be used to access the global functions that LocalScripts and ModuleScripts use.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/scripts#getrunningscripts)

getrunningscripts


-----------------------------------------------------------------------------------------------------------

Returns a list of scripts that are currently running.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/scripts#getscriptbytecode)

getscriptbytecode


-----------------------------------------------------------------------------------------------------------

Returns the raw Luau bytecode of the given script.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/scripts#getscriptclosure)

getscriptclosure


---------------------------------------------------------------------------------------------------------

Generates a new closure using the bytecode of `script`.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/scripts#getscripthash)

getscripthash


---------------------------------------------------------------------------------------------------

Returns a SHA384 hash of the script's bytecode.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/scripts#getscripts)

getscripts


---------------------------------------------------------------------------------------------

Returns a list of every script in the game.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/scripts#getsenv)

getsenv


---------------------------------------------------------------------------------------

Returns the global environment of the given script. It can be used to access variables and functions that are not defined as local.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/scripts#getthreadidentity)

getthreadidentity


-----------------------------------------------------------------------------------------------------------

Returns the identity of the current thread.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/scripts#setthreadidentity)

setthreadidentity


-----------------------------------------------------------------------------------------------------------

Sets the current thread identity.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/scripts#filtergc)

filtergc


-----------------------------------------------------------------------------------------

Filters objects in the garbage collector by `type` (`"function"` or `"table"`) and returns matching objects.

Field

Type

Description

`Name`

string?

Filters functions by debug name.

`Keys`

table?

Filters tables that contain the specified keys.

`IgnoreExecutor`

boolean?

Whether to exclude executor-created objects.

`ReturnOne`

boolean?

If true, returns the first match only (wrapped in a table).

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/scripts#getscriptfromthread)

getscriptfromthread


---------------------------------------------------------------------------------------------------------------

Returns the script associated with the given `thread`, or `nil` if none exists.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/scripts#saveinstance)

saveinstance


-------------------------------------------------------------------------------------------------

Saves the entire game to a file. Options can be provided to customize the output.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/scripts#getpcd)

getpcd


-------------------------------------------------------------------------------------

Returns the physics collision data of `part` as a hex-encoded string.

**Aliases:** `getpcdprop`

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/scripts#getbspval)

getbspval


-------------------------------------------------------------------------------------------

Returns the base server property value of `property` on `object`.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/scripts#decompile)

decompile


-------------------------------------------------------------------------------------------

Decompiles `script` and returns the decompiled Luau source code as a string.

[PreviousMiscellaneouschevron-left](https://mycompany-185.gitbook.io/mycompany-docs/miscellaneous)
[NextWeb Socketschevron-right](https://mycompany-185.gitbook.io/mycompany-docs/web-sockets)

Was this helpful?

*   [getgc](https://mycompany-185.gitbook.io/mycompany-docs/scripts#getgc)
    
*   [getgenv](https://mycompany-185.gitbook.io/mycompany-docs/scripts#getgenv)
    
*   [gettenv](https://mycompany-185.gitbook.io/mycompany-docs/scripts#gettenv)
    
*   [getreg](https://mycompany-185.gitbook.io/mycompany-docs/scripts#getreg)
    
*   [getloadedmodules](https://mycompany-185.gitbook.io/mycompany-docs/scripts#getloadedmodules)
    
*   [getrenv](https://mycompany-185.gitbook.io/mycompany-docs/scripts#getrenv)
    
*   [getrunningscripts](https://mycompany-185.gitbook.io/mycompany-docs/scripts#getrunningscripts)
    
*   [getscriptbytecode](https://mycompany-185.gitbook.io/mycompany-docs/scripts#getscriptbytecode)
    
*   [getscriptclosure](https://mycompany-185.gitbook.io/mycompany-docs/scripts#getscriptclosure)
    
*   [getscripthash](https://mycompany-185.gitbook.io/mycompany-docs/scripts#getscripthash)
    
*   [getscripts](https://mycompany-185.gitbook.io/mycompany-docs/scripts#getscripts)
    
*   [getsenv](https://mycompany-185.gitbook.io/mycompany-docs/scripts#getsenv)
    
*   [getthreadidentity](https://mycompany-185.gitbook.io/mycompany-docs/scripts#getthreadidentity)
    
*   [setthreadidentity](https://mycompany-185.gitbook.io/mycompany-docs/scripts#setthreadidentity)
    
*   [filtergc](https://mycompany-185.gitbook.io/mycompany-docs/scripts#filtergc)
    
*   [getscriptfromthread](https://mycompany-185.gitbook.io/mycompany-docs/scripts#getscriptfromthread)
    
*   [saveinstance](https://mycompany-185.gitbook.io/mycompany-docs/scripts#saveinstance)
    
*   [getpcd](https://mycompany-185.gitbook.io/mycompany-docs/scripts#getpcd)
    
*   [getbspval](https://mycompany-185.gitbook.io/mycompany-docs/scripts#getbspval)
    
*   [decompile](https://mycompany-185.gitbook.io/mycompany-docs/scripts#decompile)
    

Was this helpful?

Copy

    <table<ModuleScript>> getloadedmodules()

Copy

    <table<[string]: any>> getrenv()

Copy

    <table<LocalScript | ModuleScript>> getrunningscripts()

Copy

    <string> getscriptbytecode(<LocalScript | ModuleScript> script)

Copy

    <function> getscriptclosure(<LocalScript | ModuleScript> script)

Copy

    <string> getscripthash(<LocalScript | ModuleScript> script)

Copy

    <table<LocalScript | ModuleScript>> getscripts()

Copy

    <table<[string]: any>> getsenv(<LocalScript | ModuleScript> script)

Copy

    <number> getthreadidentity()

Copy

    <nil> setthreadidentity(<number> identity)

Copy

    <table> filtergc(<string> type, <table> options)

Copy

    local results = filtergc("function", {Name = "print"})
    print(#results) --> number of matching functions

Copy

    <LocalScript | ModuleScript>? getscriptfromthread(<thread> thread)

Copy

    <nil> saveinstance(<table?> options)

Copy

    <string> getpcd(<TriangleMeshPart> part)

Copy

    <any> getbspval(<Instance> object, <string> property)

Copy

    <string> decompile(<LocalScript | ModuleScript> script)

---

# Miscellaneous | MyCompany Docs

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/miscellaneous#identifyexecutor)

identifyexecutor


---------------------------------------------------------------------------------------------------------------

Copy

    <string, string> identifyexecutor()

Returns the name and version of Potassium.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/miscellaneous#lz4compress)

lz4compress


-----------------------------------------------------------------------------------------------------

Copy

    <string> lz4compress(<string> data)

Compresses `data` using LZ4 compression.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/miscellaneous#lz4decompress)

lz4decompress


---------------------------------------------------------------------------------------------------------

Copy

    <string> lz4compress(<string> data, <number> size)

Decompresses `data` using LZ4 compression, with the decompressed size specified by `size`.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/miscellaneous#messagebox)

messagebox


---------------------------------------------------------------------------------------------------

Copy

    <number> messagebox(<string> text, <string> caption, <number> flags)

Creates a message box with the specified text, caption, and flags. Yields until the message box is closed, and returns the user input code.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/miscellaneous#queue_on_teleport)

queue\_on\_teleport


-------------------------------------------------------------------------------------------------------------------

Queues the specified script to be executed after the player teleports to a different place.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/miscellaneous#request)

request


---------------------------------------------------------------------------------------------

Sends an HTTP request using the specified options. Yields until the request is complete, and returns the response.

Field

Type

Description

Url

string

The URL for the request.

Method

string

The HTTP method to use.

Body

string?

The body of the request.

Headers

table?

A table of headers.

Cookies

table?

A table of cookies.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/miscellaneous#getinternalparent)

getinternalparent


-----------------------------------------------------------------------------------------------------------------

Returns the internal parent field of the `instance`.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/miscellaneous#getfflag)

getfflag


-----------------------------------------------------------------------------------------------

Returns the value of `fflag`

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/miscellaneous#setfflag)

setfflag


-----------------------------------------------------------------------------------------------

Sets the value of `fflag` to `value`

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/miscellaneous#setinternalparent)

setinternalparent


-----------------------------------------------------------------------------------------------------------------

Sets the internal parent field of `instance` to `newparent`

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/miscellaneous#setclipboard)

setclipboard


-------------------------------------------------------------------------------------------------------

Copies `text` to the clipboard.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/miscellaneous#setfpscap)

setfpscap


-------------------------------------------------------------------------------------------------

Sets the in-game FPS cap to `fps`. If `fps` is 0, the FPS cap is disabled.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/miscellaneous#messageboxasync)

messageboxasync


-------------------------------------------------------------------------------------------------------------

Creates a message box with the specified text, caption, and flags. Unlike `messagebox`, this function does not yield.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/miscellaneous#clearqueueonteleport)

clearqueueonteleport


-----------------------------------------------------------------------------------------------------------------------

Clears all scripts queued with `queue_on_teleport`.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/miscellaneous#setsafeenv)

setsafeenv


---------------------------------------------------------------------------------------------------

Sets whether the environment of `target` is marked as safe (untouched). `target` can be a function or an environment table.

**Aliases:** `setuntouched`

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/miscellaneous#getsafeenv)

getsafeenv


---------------------------------------------------------------------------------------------------

Returns whether the environment of `target` is marked as safe (untouched). If no argument is provided, checks the current environment.

**Aliases:** `isuntouched`

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/miscellaneous#getfflagtype)

getfflagtype


-------------------------------------------------------------------------------------------------------

Returns the type of `fflag`, or `nil` if the flag does not exist.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/miscellaneous#psmsignal)

PsmSignal


-------------------------------------------------------------------------------------------------

Creates a new custom signal object.

**Aliases:** `Signal`

Method

Description

`Connect(<function> callback): PsmConnection`

Connects a callback to the signal. Returns a PsmConnection.

`Once(<function> callback): PsmConnection`

Connects a callback that fires only once.

`Fire(...: any): ()`

Fires the signal with the provided arguments.

`Wait(): ...any`

Yields until the signal is fired and returns the arguments.

[PreviousMetatablechevron-left](https://mycompany-185.gitbook.io/mycompany-docs/metatable)
[NextScriptschevron-right](https://mycompany-185.gitbook.io/mycompany-docs/scripts)

Was this helpful?

*   [identifyexecutor](https://mycompany-185.gitbook.io/mycompany-docs/miscellaneous#identifyexecutor)
    
*   [lz4compress](https://mycompany-185.gitbook.io/mycompany-docs/miscellaneous#lz4compress)
    
*   [lz4decompress](https://mycompany-185.gitbook.io/mycompany-docs/miscellaneous#lz4decompress)
    
*   [messagebox](https://mycompany-185.gitbook.io/mycompany-docs/miscellaneous#messagebox)
    
*   [queue\_on\_teleport](https://mycompany-185.gitbook.io/mycompany-docs/miscellaneous#queue_on_teleport)
    
*   [request](https://mycompany-185.gitbook.io/mycompany-docs/miscellaneous#request)
    
*   [getinternalparent](https://mycompany-185.gitbook.io/mycompany-docs/miscellaneous#getinternalparent)
    
*   [getfflag](https://mycompany-185.gitbook.io/mycompany-docs/miscellaneous#getfflag)
    
*   [setfflag](https://mycompany-185.gitbook.io/mycompany-docs/miscellaneous#setfflag)
    
*   [setinternalparent](https://mycompany-185.gitbook.io/mycompany-docs/miscellaneous#setinternalparent)
    
*   [setclipboard](https://mycompany-185.gitbook.io/mycompany-docs/miscellaneous#setclipboard)
    
*   [setfpscap](https://mycompany-185.gitbook.io/mycompany-docs/miscellaneous#setfpscap)
    
*   [messageboxasync](https://mycompany-185.gitbook.io/mycompany-docs/miscellaneous#messageboxasync)
    
*   [clearqueueonteleport](https://mycompany-185.gitbook.io/mycompany-docs/miscellaneous#clearqueueonteleport)
    
*   [setsafeenv](https://mycompany-185.gitbook.io/mycompany-docs/miscellaneous#setsafeenv)
    
*   [getsafeenv](https://mycompany-185.gitbook.io/mycompany-docs/miscellaneous#getsafeenv)
    
*   [getfflagtype](https://mycompany-185.gitbook.io/mycompany-docs/miscellaneous#getfflagtype)
    
*   [PsmSignal](https://mycompany-185.gitbook.io/mycompany-docs/miscellaneous#psmsignal)
    

Was this helpful?

Copy

    <nil> queue_on_teleport(<string> code)

Copy

    <HttpResponse> request(<HttpRequest> options)

Copy

    <Instance> getinternalparent(<Instance> instance)

Copy

    <any> getfflag(<string> fflag)

Copy

    <nil> setfflag(<string> fflag, <any> value)

Copy

    <nil> setinternalparent(<Instance> instance, <Instance> newparent)

Copy

    <nil> setclipboard(<string> text)

Copy

    <nil> setfpscap(<number> fps)

Copy

    <nil> messageboxasync(<string> text, <string> caption, <number> flags)

Copy

    <nil> clearqueueonteleport()

Copy

    <nil> setsafeenv(<function | table> target, <boolean> safe)

Copy

    <boolean> getsafeenv(<function | table>? target)

Copy

    <string?> getfflagtype(<string> fflag)

Copy

    <PsmSignal> PsmSignal.new()

---

# oth | MyCompany Docs

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/oth#oth.hook)

oth.hook


-------------------------------------------------------------------------------------

Copy

    <nil> oth.hook(<thread> thread, <function> callback)

Hooks a thread, replacing its callback with the provided function.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/oth#oth.unhook)

oth.unhook


-----------------------------------------------------------------------------------------

Copy

    <nil> oth.unhook(<thread> thread)

Unhooks a previously hooked thread, restoring its original callback.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/oth#oth.get_original_thread)

oth.get\_original\_thread


---------------------------------------------------------------------------------------------------------------------

Copy

    <thread?> oth.get_original_thread(<thread> thread)

Returns the original thread if `thread` is a hook thread, or `nil` otherwise.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/oth#oth.is_hook_thread)

oth.is\_hook\_thread


-----------------------------------------------------------------------------------------------------------

Copy

    <boolean> oth.is_hook_thread(<thread> thread)

Returns whether `thread` is a hook thread created by `oth.hook`.

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/oth#oth.get_root_callback)

oth.get\_root\_callback


-----------------------------------------------------------------------------------------------------------------

Returns the root callback of `thread`, before any hooks were applied.

[PreviousCryptchevron-left](https://mycompany-185.gitbook.io/mycompany-docs/crypt)
[NextRakNetchevron-right](https://mycompany-185.gitbook.io/mycompany-docs/raknet)

Was this helpful?

*   [oth.hook](https://mycompany-185.gitbook.io/mycompany-docs/oth#oth.hook)
    
*   [oth.unhook](https://mycompany-185.gitbook.io/mycompany-docs/oth#oth.unhook)
    
*   [oth.get\_original\_thread](https://mycompany-185.gitbook.io/mycompany-docs/oth#oth.get_original_thread)
    
*   [oth.is\_hook\_thread](https://mycompany-185.gitbook.io/mycompany-docs/oth#oth.is_hook_thread)
    
*   [oth.get\_root\_callback](https://mycompany-185.gitbook.io/mycompany-docs/oth#oth.get_root_callback)
    

Was this helpful?

Copy

    <function?> oth.get_root_callback(<thread> thread)

---

# Regex | MyCompany Docs

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/regex#regex.new)

Regex.new


-----------------------------------------------------------------------------------------

Copy

    <RegexObject> Regex.new(<string> pattern)

Creates a new Regex object from the given `pattern`.

Method

Description

`Match(<string> input): string?`

Returns the first match of the pattern in `input`.

`Replace(<string> input, <string> replacement): string`

Replaces matches of the pattern in `input` with `replacement`.

Copy

    local regex = Regex.new("[%w]+@[%w]+")
    print(regex:Match("user@domain test@email")) --> user@domain

[hashtag](https://mycompany-185.gitbook.io/mycompany-docs/regex#regex.escape)

Regex.Escape


-----------------------------------------------------------------------------------------------

Copy

    <string> Regex.Escape(<string> str)

Escapes all special regex characters in `str`.

Copy

    print(Regex.Escape("hello.world+test")) --> hello\.world\+test

[PreviousRakNetchevron-left](https://mycompany-185.gitbook.io/mycompany-docs/raknet)

Was this helpful?

*   [Regex.new](https://mycompany-185.gitbook.io/mycompany-docs/regex#regex.new)
    
*   [Regex.Escape](https://mycompany-185.gitbook.io/mycompany-docs/regex#regex.escape)
    

Was this helpful?

---