Guides

SDK_DescriptionAttribute

extends Attribute

Overview

Describes a class that represents an SDK. Only allowed on classes that inherit from SDK_Base.

Class Variables

  • public readonly string prettyName - The pretty name of the SDK. Uniquely identifies the SDK.
  • public readonly string symbol - The scripting define symbol needed for the SDK. Needs to be the same as SDK_ScriptingDefineSymbolPredicateAttribute.symbol to add and remove the scripting define symbol automatically using VRTK_SDKManager.
  • public readonly string vrDeviceName - The name of the VR Device to load.
  • public readonly int index - The index of this attribute, in case there are multiple on the same target.
  • public BuildTargetGroup buildTargetGroup - The build target group this SDK is for.
  • public bool describesFallbackSDK - Whether this description describes a fallback SDK.

Class Methods

SDK_DescriptionAttribute/5

public SDK_DescriptionAttribute(string prettyName, string symbol, string vrDeviceName, string buildTargetGroupName, int index = 0)

  • Parameters
    • string prettyName - The pretty name of the SDK. Uniquely identifies the SDK. null and string.Empty aren't allowed.
    • string symbol - The scripting define symbol needed for the SDK. Needs to be the same as SDK_ScriptingDefineSymbolPredicateAttribute.symbol to add and remove the scripting define symbol automatically using VRTK_SDKManager. null and string.Empty are allowed.
    • string vrDeviceName - The name of the VR Device to load. Set to null or string.Empty if no VR Device is needed.
    • string buildTargetGroupName - The name of a constant of BuildTargetGroup. BuildTargetGroup.Unknown, null and string.Empty are not allowed.
    • int index - The index of this attribute, in case there are multiple on the same target.
  • Returns
    • none

Creates a new attribute.

SDK_DescriptionAttribute/2

public SDK_DescriptionAttribute(Type typeToCopyExistingDescriptionFrom, int index = 0)

  • Parameters
    • Type typeToCopyExistingDescriptionFrom - The type to copy the existing SDK_DescriptionAttribute from. null is not allowed.
    • int index - The index of the description to copy from the the existing SDK_DescriptionAttribute.
  • Returns
    • none

Creates a new attribute by copying from another attribute on a given type.


Did this page help you?