Reference API Roblox

Engine API

Website

Related

Reference API Roblox

PluginCapabilities

Declares a plugin's capabilities (the data models it targets and the permissions it requests) through a JSON manifest.

Memory categoryInstances

Member index 1

HistoryMember
731Manifest: string
inherited from Instance
731Archivable: bool
731Capabilities: SecurityCapabilities
731IsInSandbox: bool
731Name: string
731Parent: Instance
731PredictionMode: PredictionMode
731Sandboxed: bool
731UniqueId: UniqueId
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631GetAttributes(): Dictionary
648GetChildren(): Instances
462GetDebugId(scopeLength: int = 4): string
707GetDescendants(): Instances
486GetFullName(): string
706GetStyled(name: string, selector: string?): Variant
657GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
664IsPropertyModified(property: string): bool
698QueryDescendants(selector: string): Instances
573Remove(): null
576RemoveTag(tag: string): null
664ResetPropertyToDefault(property: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
731children(): Instances
731clone(): Instance
731destroy(): null
731findFirstChild(name: string, recursive: bool = false): Instance
731getChildren(): Instances
731isDescendantOf(ancestor: Instance): bool
731remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
657StyledPropertiesChanged()
731childAdded(child: Instance)
inherited from Object
731ClassName: string
731className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
731isA(className: string): bool
647Changed(property: string)

Description

PluginCapabilities describes what a plugin is allowed to do. Its Manifest property holds a JSON string that declares which data models the plugin targets (such as Edit, Server, and Client) and the permissions the plugin requests. It's used by built-in and standalone plugins to record their declared capabilities.

History 4

  • 731 Change Default of Manifest from to {"Metadata":{"TargetDataModels": ["Edit", "Server", "Client"]},"Permissions":{}}
  • 726 Change Default of Manifest from {"Metadata":{"TargetDataModels": ["Edit", "Server", "Client"]},"Permissions":{}} to
  • 587 Add Manifest
  • 587 Add PluginCapabilities

Members 1

Manifest

TypeDefault
string{"Metadata":{"TargetDataModels": ["Edit", "Server", "Client"]},"Permissions":{}}

A JSON-encoded string describing the plugin's declared capabilities. It contains a Metadata object whose TargetDataModels array names the data models the plugin runs against (Edit, Server, and Client), and a Permissions object listing the permissions the plugin requests. Defaults to {"Metadata":{"TargetDataModels": ["Edit", "Server", "Client"]},"Permissions":{}}, which targets all three data models and requests no additional permissions.

SecurityRobloxScriptSecurity
Thread safetyReadSafe
CategoryData
Loaded/Savedtrue

History 3

  • 731 Change Default of Manifest from to {"Metadata":{"TargetDataModels": ["Edit", "Server", "Client"]},"Permissions":{}}
  • 726 Change Default of Manifest from {"Metadata":{"TargetDataModels": ["Edit", "Server", "Client"]},"Permissions":{}} to
  • 587 Add Manifest

Settings