Description

A sandboxed version of Instance.

Properties

Type Key Default Value
string ClassName Instance
string Name ClassName#counter
table ClassList {userdata}

Methods

Return Type Name
Instance Get (name: string)
table List (pattern: string?, search: boolean?)
nil DestroyList (pattern: string?, search: boolean?)

Property Descriptions

string Name = ClassName#counter

  • By default, every new instance will be named by it’s ClassName followed by it’s index counter.
  • Instance keeps track of all instances it creates and continuously increment a counter.

table ClassList = {userdata}

  • This table is a dictionary of classes that are available in this ZSharp environment.
  • These classes are not usable and just are proxies of actual classes.

Method Descriptions

Instance Get(name: string)

  • Gets a Instance by name. If there are multiple instances with the same name, it will only return the first one found.
  • The return value can differ base on the instance’s class, if the instance stored is a Sound, it will return a Sound.

table List(pattern: string?, search: boolean?)

  • Returns a list of instances.
  • pattern ~= nil
    • Then it will return every available instance.
  • pattern ~= nil and search ~= true
    • Then it will search for instances with names exactly matches the pattern.
  • pattern ~= nil and search == true
    • Then it will string.match instances with names matching the pattern.

nil DestroyList(pattern: string?, search: boolean?)

  • pattern & search works the same as List
  • It will destroy every matching item.

Table of contents