Away 8:44 PM

2 min read

Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.

roblox.engine.InstanceDetails — cloud.docs

Contains instance type-specific details about a data model instance.

Properties

NameTypeRequiredDescription
Folder#/components/schemas/roblox.engine.FolderfalseA simple container used to hold and organize Roblox instances.
LocalScript#/components/schemas/roblox.engine.LocalScriptfalseA LocalScript is a Lua code container that runs its contents on the client (player's device) instead of the server.
ModuleScript#/components/schemas/roblox.engine.ModuleScriptfalseA ModuleScript is a type of Lua source container that runs once and must return exactly one value.
Script#/components/schemas/roblox.engine.ScriptfalseA Script is a Lua code container that can access server-side objects, properties, and events, such as to award badges to players using BadgeService, while LocalScripts on the client cannot.

Complete Schema

{
  "type": "object",
  "properties": {
    "Folder": {
      "$ref": "#/components/schemas/roblox.engine.Folder",
      "description": "A simple container used to hold and organize Roblox instances."
    },
    "LocalScript": {
      "$ref": "#/components/schemas/roblox.engine.LocalScript",
      "description": "A LocalScript is a Lua code container that runs its contents on the client (player's device) instead of the server."
    },
    "ModuleScript": {
      "$ref": "#/components/schemas/roblox.engine.ModuleScript",
      "description": "A ModuleScript is a type of Lua source container that runs once and must return exactly one value."
    },
    "Script": {
      "$ref": "#/components/schemas/roblox.engine.Script",
      "description": "A Script is a Lua code container that can access server-side objects, properties, and events, such as to award badges to players using BadgeService, while LocalScripts on the client cannot."
    }
  },
  "description": "Contains instance type-specific details about a data model instance.",
  "x-oneOf": {
    "kind": [
      "Folder",
      "LocalScript",
      "ModuleScript",
      "Script"
    ]
  }
}