MetaAPI

docs.metaapi

MetaAPI.getName

docs.metaapi.getname

overload 1:
                        
MetaAPI:getName()  
 Method Property Fluent Description Representation
Return Value a String String

Method Property	Fluent Description	Representation
Return Value	a String	`String`

MetaAPI.store

docs.metaapi.store

overload 1:
                        
MetaAPI:store(key, value)  
 Method Property Fluent Description Representation
key accepts a String String 
   
value accepts anything AnyType 
   
Return Value nil nil

Method Property	Fluent Description	Representation
key accepts	a String	`String`
value accepts	anything	`AnyType`
Return Value	nil	`nil`

MetaAPI.getSize

docs.metaapi.getsize

overload 1:
                        
MetaAPI:getSize()  
 Method Property Fluent Description Representation
Return Value a Number Number

Method Property	Fluent Description	Representation
Return Value	a Number	`Number`

MetaAPI.getVersion

docs.metaapi.getversion

overload 1:
                        
MetaAPI:getVersion()  
 Method Property Fluent Description Representation
Return Value a String String

Method Property	Fluent Description	Representation
Return Value	a String	`String`

MetaAPI.setColor

docs.metaapi.setcolor

overload 1:
                        
MetaAPI:setColor(color)  
 Method Property Fluent Description Representation
color accepts a Vector3 Vector3 
   
Return Value nil nil 
   
overload 2:
                        
MetaAPI:setColor(r, g, b)  
 Method Property Fluent Description Representation
r accepts a Number Number 
   
g accepts a Number Number 
   
b accepts a Number Number 
   
Return Value nil nil

Method Property	Fluent Description	Representation
color accepts	a Vector3	`Vector3`
Return Value	nil	`nil`

Method Property	Fluent Description	Representation
r accepts	a Number	`Number`
g accepts	a Number	`Number`
b accepts	a Number	`Number`
Return Value	nil	`nil`

MetaAPI.getAuthors

docs.metaapi.getauthors

overload 1:
                        
MetaAPI:getAuthors()  
 Method Property Fluent Description Representation
Return Value a String String

Method Property	Fluent Description	Representation
Return Value	a String	`String`

MetaAPI.hasTexture

docs.metaapi.hastexture

overload 1:
                        
MetaAPI:hasTexture()  
 Method Property Fluent Description Representation
Return Value a Boolean Boolean

Method Property	Fluent Description	Representation
Return Value	a Boolean	`Boolean`

MetaAPI.hasScriptError

docs.metaapi.hasscripterror

overload 1:
                        
MetaAPI:hasScriptError()  
 Method Property Fluent Description Representation
Return Value a Boolean Boolean

Method Property	Fluent Description	Representation
Return Value	a Boolean	`Boolean`

MetaAPI.getInitCount

docs.metaapi.getinitcount

overload 1:
                        
MetaAPI:getInitCount()  
 Method Property Fluent Description Representation
Return Value an Integer Integer

Method Property	Fluent Description	Representation
Return Value	an Integer	`Integer`

MetaAPI.getTickCount

docs.metaapi.gettickcount

overload 1:
                        
MetaAPI:getTickCount()  
 Method Property Fluent Description Representation
Return Value an Integer Integer

Method Property	Fluent Description	Representation
Return Value	an Integer	`Integer`

MetaAPI.getMaxInitCount

docs.metaapi.getmaxinitcount

overload 1:
                        
MetaAPI:getMaxInitCount()  
 Method Property Fluent Description Representation
Return Value an Integer Integer

Method Property	Fluent Description	Representation
Return Value	an Integer	`Integer`

MetaAPI.getMaxTickCount

docs.metaapi.getmaxtickcount

overload 1:
                        
MetaAPI:getMaxTickCount()  
 Method Property Fluent Description Representation
Return Value an Integer Integer

Method Property	Fluent Description	Representation
Return Value	an Integer	`Integer`

MetaAPI.getRenderCount

docs.metaapi.getrendercount

overload 1:
                        
MetaAPI:getRenderCount()  
 Method Property Fluent Description Representation
Return Value an Integer Integer

Method Property	Fluent Description	Representation
Return Value	an Integer	`Integer`

MetaAPI.getWorldTickCount

docs.metaapi.getworldtickcount

overload 1:
                        
MetaAPI:getWorldTickCount()  
 Method Property Fluent Description Representation
Return Value an Integer Integer

Method Property	Fluent Description	Representation
Return Value	an Integer	`Integer`

MetaAPI.getMaxScriptMemory

docs.metaapi.getmaxscriptmemory

overload 1:
                        
MetaAPI:getMaxScriptMemory()  
 Method Property Fluent Description Representation
Return Value an Integer Integer

Method Property	Fluent Description	Representation
Return Value	an Integer	`Integer`

MetaAPI.getMaxSounds

docs.metaapi.getmaxsounds

overload 1:
                        
MetaAPI:getMaxSounds()  
 Method Property Fluent Description Representation
Return Value an Integer Integer

Method Property	Fluent Description	Representation
Return Value	an Integer	`Integer`

MetaAPI.getMaxRenderCount

docs.metaapi.getmaxrendercount

overload 1:
                        
MetaAPI:getMaxRenderCount()  
 Method Property Fluent Description Representation
Return Value an Integer Integer

Method Property	Fluent Description	Representation
Return Value	an Integer	`Integer`

MetaAPI.getRemainingSounds

docs.metaapi.getremainingsounds

overload 1:
                        
MetaAPI:getRemainingSounds()  
 Method Property Fluent Description Representation
Return Value an Integer Integer

Method Property	Fluent Description	Representation
Return Value	an Integer	`Integer`

MetaAPI.getComplexity

docs.metaapi.getcomplexity

overload 1:
                        
MetaAPI:getComplexity()  
 Method Property Fluent Description Representation
Return Value an Integer Integer

Method Property	Fluent Description	Representation
Return Value	an Integer	`Integer`

MetaAPI.getScriptMemory

docs.metaapi.getscriptmemory

overload 1:
                        
MetaAPI:getScriptMemory()  
 Method Property Fluent Description Representation
Return Value an Integer Integer

Method Property	Fluent Description	Representation
Return Value	an Integer	`Integer`

MetaAPI.getMaxComplexity

docs.metaapi.getmaxcomplexity

overload 1:
                        
MetaAPI:getMaxComplexity()  
 Method Property Fluent Description Representation
Return Value an Integer Integer

Method Property	Fluent Description	Representation
Return Value	an Integer	`Integer`

MetaAPI.getMaxParticles

docs.metaapi.getmaxparticles

overload 1:
                        
MetaAPI:getMaxParticles()  
 Method Property Fluent Description Representation
Return Value an Integer Integer

Method Property	Fluent Description	Representation
Return Value	an Integer	`Integer`

MetaAPI.canEditNameplate

docs.metaapi.caneditnameplate

overload 1:
                        
MetaAPI:canEditNameplate()  
 Method Property Fluent Description Representation
Return Value a Boolean Boolean

Method Property	Fluent Description	Representation
Return Value	a Boolean	`Boolean`

MetaAPI.canRenderOffscreen

docs.metaapi.canrenderoffscreen

overload 1:
                        
MetaAPI:canRenderOffscreen()  
 Method Property Fluent Description Representation
Return Value a Boolean Boolean

Method Property	Fluent Description	Representation
Return Value	a Boolean	`Boolean`

MetaAPI.canUseCustomSounds

docs.metaapi.canusecustomsounds

overload 1:
                        
MetaAPI:canUseCustomSounds()  
 Method Property Fluent Description Representation
Return Value a Boolean Boolean

Method Property	Fluent Description	Representation
Return Value	a Boolean	`Boolean`

MetaAPI.getColor

docs.metaapi.getcolor

overload 1:
                        
MetaAPI:getColor()  
 Method Property Fluent Description Representation
Return Value a String String

Method Property	Fluent Description	Representation
Return Value	a String	`String`

MetaAPI.getRemainingParticles

docs.metaapi.getremainingparticles

overload 1:
                        
MetaAPI:getRemainingParticles()  
 Method Property Fluent Description Representation
Return Value an Integer Integer

Method Property	Fluent Description	Representation
Return Value	an Integer	`Integer`

MetaAPI.getWorldRenderCount

docs.metaapi.getworldrendercount

overload 1:
                        
MetaAPI:getWorldRenderCount()  
 Method Property Fluent Description Representation
Return Value an Integer Integer

Method Property	Fluent Description	Representation
Return Value	an Integer	`Integer`

MetaAPI.getAnimationComplexity

docs.metaapi.getanimationcomplexity

overload 1:
                        
MetaAPI:getAnimationComplexity()  
 Method Property Fluent Description Representation
Return Value an Integer Integer

Method Property	Fluent Description	Representation
Return Value	an Integer	`Integer`

MetaAPI.canEditVanillaModel

docs.metaapi.caneditvanillamodel

overload 1:
                        
MetaAPI:canEditVanillaModel()  
 Method Property Fluent Description Representation
Return Value a Boolean Boolean

Method Property	Fluent Description	Representation
Return Value	a Boolean	`Boolean`

MetaAPI.getMaxAnimationComplexity

docs.metaapi.getmaxanimationcomplexity

overload 1:
                        
MetaAPI:getMaxAnimationComplexity()  
 Method Property Fluent Description Representation
Return Value an Integer Integer

Method Property	Fluent Description	Representation
Return Value	an Integer	`Integer`

MetaAPI.getMaxWorldRenderCount

docs.metaapi.getmaxworldrendercount

overload 1:
                        
MetaAPI:getMaxWorldRenderCount()  
 Method Property Fluent Description Representation
Return Value an Integer Integer

Method Property	Fluent Description	Representation
Return Value	an Integer	`Integer`

MetaAPI.getMaxWorldTickCount

docs.metaapi.getmaxworldtickcount

overload 1:
                        
MetaAPI:getMaxWorldTickCount()  
 Method Property Fluent Description Representation
Return Value an Integer Integer

Global Objects

Miscellaneous Types

action_wheel

world

keybind

model

math

event

nameplate

entity

misc

Miscellaneous Enums