{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","results":{"codes":[]},"settings":"","params":[]},"next":{"description":"","pages":[]},"title":"SDK_DescriptionAttribute","type":"basic","slug":"sdk_descriptionattribute","excerpt":"","body":"> extends Attribute\n\n## Overview\n\nDescribes a class that represents an SDK. Only allowed on classes that inherit from SDK_Base.\n\n## Class Variables\n\n * `public readonly string prettyName` - The pretty name of the SDK. Uniquely identifies the SDK.\n * `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.\n * `public readonly string vrDeviceName` - The name of the VR Device to load.\n * `public readonly int index` - The index of this attribute, in case there are multiple on the same target.\n * `public BuildTargetGroup buildTargetGroup` - The build target group this SDK is for.\n * `public bool describesFallbackSDK` - Whether this description describes a fallback SDK.\n\n## Class Methods\n\n### SDK_DescriptionAttribute/5\n\n  > `public SDK_DescriptionAttribute(string prettyName, string symbol, string vrDeviceName, string buildTargetGroupName, int index = 0)`\n\n * Parameters\n   * `string prettyName` - The pretty name of the SDK. Uniquely identifies the SDK. `null` and `string.Empty` aren't allowed.\n   * `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.\n   * `string vrDeviceName` - The name of the VR Device to load. Set to `null` or `string.Empty` if no VR Device is needed.\n   * `string buildTargetGroupName` - The name of a constant of `BuildTargetGroup`. `BuildTargetGroup.Unknown`, `null` and `string.Empty` are not allowed.\n   * `int index` - The index of this attribute, in case there are multiple on the same target.\n * Returns\n   * _none_\n\nCreates a new attribute.\n\n### SDK_DescriptionAttribute/2\n\n  > `public SDK_DescriptionAttribute(Type typeToCopyExistingDescriptionFrom, int index = 0)`\n\n * Parameters\n   * `Type typeToCopyExistingDescriptionFrom` - The type to copy the existing SDK_DescriptionAttribute from. `null` is not allowed.\n   * `int index` - The index of the description to copy from the the existing SDK_DescriptionAttribute.\n * Returns\n   * _none_\n\nCreates a new attribute by copying from another attribute on a given type.","updates":[],"order":2,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5b1f8576c2505d00031254d0","project":"571fa55ca0acd42000af9545","version":{"version":"3.3.0","version_clean":"3.3.0","codename":"Mangalica","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5b1f8576c2505d0003125424","5b1f8576c2505d0003125425","5b1f8576c2505d0003125426","5b1f8576c2505d0003125427","5b1f8576c2505d0003125428","5b1f8576c2505d0003125429","5b1f8576c2505d000312542a","5b1f8576c2505d000312542b","5b1f8576c2505d000312542c","5b1f8576c2505d000312542d","5b1f8576c2505d000312542e","5b1f8576c2505d000312542f","5b1f8576c2505d0003125430","5b1f8576c2505d0003125431","5b1f8576c2505d0003125432","5b1f8576c2505d0003125433","5b1f8576c2505d0003125434","5b1f8576c2505d0003125435","5b1f8576c2505d0003125436","5b1f8576c2505d0003125437","5b1f8576c2505d0003125438","5b1f8aab9c683000032979e7","5b1f8b2f3073470003ffa5da","5b1f8bd9fd653400031d94f4","5b1f900bd4c5f000036b57bd"],"_id":"5b1f8576c2505d00031254db","project":"571fa55ca0acd42000af9545","__v":4,"forked_from":"594949e52be16d0026ec04cd","createdAt":"2017-06-20T16:14:29.816Z","releaseDate":"2017-06-20T16:14:29.816Z"},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Base SDK","slug":"base-sdk","order":15,"from_sync":false,"reference":false,"_id":"5b1f8576c2505d0003125432","version":"5b1f8576c2505d00031254db","project":"571fa55ca0acd42000af9545","createdAt":"2017-01-01T19:32:06.235Z","__v":0},"user":"571fa519db52d01700f5cf3d","createdAt":"2017-06-20T18:30:53.965Z","githubsync":"","__v":0,"parentDoc":null}

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.