Skip to content

AddonObject

AddonObject represents an addon in the creator. This object serves as the main interface for addon developers to interact with the addon system.

Not newable

This object cannot be created by scripts using Instance.New().

Properties

Identifier : string

The identifier for this addon.

AddonName : string

The display name of the addon. This name will appear in the tools menu.

AddonIcon : PTImageAsset

Determines the addon icon.

Methods

RequestPermissions → nil

Parameters: perms [ { AddonPermissionEnum } ]

Prompt the user to request for permissions

CreateToolItem → AddonToolItem

Parameters: txt [ string ]

Create a new tool item with text.

Events

CleanupReceived

Parameters: ``

Fires when cleanup has been requested by the creator, this is usually fires when updating the addon.