UIKitItemDescription

Inherits from UIItemDescription

Summary

Constructors

UIKitItemDescription()
UIKitItemDescription(guid: Guid)
UIKitItemDescription(other: UIItemDescription)
UIKitItemDescription(other: DataContainer)

Properties

Name Type
name string
unlockName string
description string
category string
texturePath string
iconTexturePath string
unlockTexturePath string
hudIcon UIHudIcon
notExplicitelySelectable bool
hiddenInProgression bool

Static members

Name Type
UIKitItemDescription.typeInfo TypeInformation

Constructors

UIKitItemDescription

UIKitItemDescription()

Creates a new UIKitItemDescription frostbite instance.

UIKitItemDescription

UIKitItemDescription(guid: Guid)

Creates a new UIKitItemDescription frostbite instance and assigns it the provided Guid.

Parameters

Name Type Description
guid Guid The Guid to assign to the newly created instance.

UIKitItemDescription

UIKitItemDescription(other: UIItemDescription)

Casts an instance of type UIItemDescription to UIKitItemDescription. Will throw an error when trying to cast from an unsupported type.

Parameters

Name Type Description
other UIItemDescription The instance to cast to UIKitItemDescription.

UIKitItemDescription

UIKitItemDescription(other: DataContainer)

Casts an instance of type DataContainer to UIKitItemDescription. Will throw an error when trying to cast from an unsupported type.

Parameters

Name Type Description
other DataContainer The instance to cast to UIKitItemDescription.

Properties

name

string

unlockName

string

description

string

category

string

texturePath

string

iconTexturePath

string

unlockTexturePath

string

hudIcon

UIHudIcon

notExplicitelySelectable

bool

hiddenInProgression

bool

Static members

typeInfo

TypeInformation

The type information for the UIKitItemDescription type.

Last modified April 26, 2020: Update frostbite type documentation (8b14351)