Source
This page was generated with Wiki Builder. Do not change the format!
Info
The list of perks to display in an item tooltip - and whether or not they have been activated. Perks apply a variety of effects to a character, and are generally either intrinsic to the item or provided in activated talent nodes or sockets.
Schema
- Schema Type: Class
- Type: object
Properties
| Name | Type | Description |
|---|---|---|
| perkHash | Destiny.Definitions.DestinySandboxPerkDefinition:integer:uint32 | The hash identifier for the perk, which can be used to look up DestinySandboxPerkDefinition if it exists. Be warned, perks frequently do not have user-viewable information. You should examine whether you actually found a name/description in the perk's definition before you show it to the user. |
| iconPath | string | The icon for the perk. |
| isActive | boolean | Whether this perk is currently active. (We may return perks that you have not actually activated yet: these represent perks that you should show in the item's tooltip, but that the user has not yet activated.) |
| visible | boolean | Some perks provide benefits, but aren't visible in the UI. This value will let you know if this is perk should be shown in your UI. |
Example
{
// Type: Destiny.Definitions.DestinySandboxPerkDefinition:integer:uint32
"perkHash": 0,
// Type: string
"iconPath": "",
// Type: boolean
"isActive": false,
// Type: boolean
"visible": false
}