unreal.PluginDescriptorToolsetInfo

class unreal.PluginDescriptorToolsetInfo(friendly_name: str = '', description: str = '', category: str = '', version_name: str = '', version: int = 0, created_by: str = '', created_by_url: str = '', docs_url: str = '', marketplace_url: str = '', support_url: str = '', can_contain_content: bool = False, is_beta_version: bool = False, is_experimental_version: bool = False, is_sealed: bool = False)

Bases: StructBase

Editable metadata fields from a plugin’s descriptor.

C++ Source:

  • Plugin: PluginToolset

  • Module: PluginToolset

  • File: PluginToolset.h

Editor Properties: (see get_editor_property/set_editor_property)

  • can_contain_content (bool): [Read-Write] Can this plugin contain content?

  • category (str): [Read-Write] The name of the category this plugin belongs to.

  • created_by (str): [Read-Write] The company or individual who created this plugin. This is an optional field that may be displayed in the user interface.

  • created_by_url (str): [Read-Write] Hyperlink URL string for the company or individual who created this plugin. This is optional.

  • description (str): [Read-Write] Description of the plugin.

  • docs_url (str): [Read-Write] Documentation URL string.

  • friendly_name (str): [Read-Write] Friendly name of the plugin.

  • is_beta_version (bool): [Read-Write] Marks the plugin as beta in the UI.

  • is_experimental_version (bool): [Read-Write] Marks the plugin as experimental in the UI.

  • is_sealed (bool): [Read-Write] Prevents other plugins from depending on this plugin.

  • marketplace_url (str): [Read-Write] Marketplace URL for this plugin. This URL will be embedded into projects that enable this plugin, so we can redirect to the marketplace if a user doesn’t have it installed.

  • support_url (str): [Read-Write] Support URL/email for this plugin.

  • version (int32): [Read-Write] Version number for the plugin. The version number must increase with every version of the plugin, so that the system can determine whether one version of a plugin is newer than another, or to enforce other requirements. This version number is not displayed in front-facing UI. Use the VersionName for that.

  • version_name (str): [Read-Write] Name of the version for this plugin. This is the front-facing part of the version number. It doesn’t need to match the version number numerically, but should be updated when the version number is increased accordingly.

property can_contain_content: bool

[Read-Write] Can this plugin contain content?

Type:

(bool)

property category: str

[Read-Write] The name of the category this plugin belongs to.

Type:

(str)

property created_by: str

[Read-Write] The company or individual who created this plugin. This is an optional field that may be displayed in the user interface.

Type:

(str)

property created_by_url: str

[Read-Write] Hyperlink URL string for the company or individual who created this plugin. This is optional.

Type:

(str)

property description: str

[Read-Write] Description of the plugin.

Type:

(str)

property docs_url: str

[Read-Write] Documentation URL string.

Type:

(str)

property friendly_name: str

[Read-Write] Friendly name of the plugin.

Type:

(str)

property is_beta_version: bool

[Read-Write] Marks the plugin as beta in the UI.

Type:

(bool)

property is_experimental_version: bool

[Read-Write] Marks the plugin as experimental in the UI.

Type:

(bool)

property is_sealed: bool

[Read-Write] Prevents other plugins from depending on this plugin.

Type:

(bool)

property marketplace_url: str

[Read-Write] Marketplace URL for this plugin. This URL will be embedded into projects that enable this plugin, so we can redirect to the marketplace if a user doesn’t have it installed.

Type:

(str)

property support_url: str

[Read-Write] Support URL/email for this plugin.

Type:

(str)

property version: int

[Read-Write] Version number for the plugin. The version number must increase with every version of the plugin, so that the system can determine whether one version of a plugin is newer than another, or to enforce other requirements. This version number is not displayed in front-facing UI. Use the VersionName for that.

Type:

(int32)

property version_name: str

[Read-Write] Name of the version for this plugin. This is the front-facing part of the version number. It doesn’t need to match the version number numerically, but should be updated when the version number is increased accordingly.

Type:

(str)