Skip to content

Commit 26c837c

Browse files
Move gcinfo() to Lua Globals
1 parent 9177b1d commit 26c837c

File tree

2 files changed

+14
-14
lines changed

2 files changed

+14
-14
lines changed

content/en-us/reference/engine/globals/LuaGlobals.yaml

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ functions:
6464
Roblox's Lua sandbox only allows the `count` option to be used (the total
6565
memory in use by Lua, in kilobytes), as other options can interfere with
6666
existing processes. Effectively, this makes
67-
`Global.RobloxGlobals.gcinfo()` a superior alternative that should be used
67+
`Global.LuaGlobals.gcinfo()` a superior alternative that should be used
6868
instead.
6969
parameters:
7070
- name: operation
@@ -79,6 +79,19 @@ functions:
7979
tags:
8080
- Deprecated
8181
code_samples:
82+
- name: gcinfo
83+
summary: |
84+
Returns the total memory heap size in kilobytes.
85+
description: |
86+
Returns the total memory heap size in kilobytes. The number reflects the
87+
current heap consumption from the operating system perspective, which
88+
fluctuates over time as garbage collector frees objects.
89+
parameters:
90+
returns:
91+
- type: number
92+
summary: ''
93+
tags:
94+
code_samples:
8295
- name: error
8396
summary: |
8497
Halts thread execution and throws an error.

content/en-us/reference/engine/globals/RobloxGlobals.yaml

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -146,19 +146,6 @@ functions:
146146
summary: ''
147147
tags:
148148
code_samples:
149-
- name: gcinfo
150-
summary: |
151-
Returns the total memory heap size in kilobytes.
152-
description: |
153-
Returns the total memory heap size in kilobytes. The number reflects the
154-
current heap consumption from the operating system perspective, which
155-
fluctuates over time as garbage collector frees objects.
156-
parameters:
157-
returns:
158-
- type: number
159-
summary: ''
160-
tags:
161-
code_samples:
162149
- name: PluginManager
163150
summary: |
164151
Refers to the PluginManager, a deprecated singleton that was previously

0 commit comments

Comments
 (0)